feat(ctp): deploy NFT bridge to Kovan (#2791)

Adds deployment artifacts for our Kovan deployment of the NFT bridge and
all related proxy contracts. Also includes an update to
contracts-bedrock to properly export contract sources.
Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>

.changeset/sixty-chefs-end.md

+---
+'@eth-optimism/contracts-periphery': patch
+---
+
+Deploy NFT bridge contracts

.changeset/tidy-cats-wait.md

+---
+'@eth-optimism/contracts-bedrock': patch
+---
+
+Have contracts-bedrock properly include contract sources in npm package

packages/contracts-bedrock/hardhat.config.ts

 import { ethers } from 'ethers'
 import { HardhatUserConfig, task, subtask } from 'hardhat/config'
 import { TASK_COMPILE_SOLIDITY_GET_SOURCE_PATHS } from 'hardhat/builtin-tasks/task-names'
+
+// Hardhat plugins
 import '@nomiclabs/hardhat-waffle'
 import '@typechain/hardhat'
 import 'solidity-coverage'
@@ -8,6 +10,7 @@ import 'hardhat-deploy'
 import '@foundry-rs/hardhat-forge'
 import '@eth-optimism/hardhat-deploy-config'
 
+// Hardhat tasks
 import './tasks/deposits'
 
 subtask(TASK_COMPILE_SOLIDITY_GET_SOURCE_PATHS).setAction(

packages/contracts-bedrock/package.json

@@ -10,7 +10,8 @@
     "dist/**/*.d.ts",
     "dist/types/*.ts",
     "artifacts/src/**/*.json",
-    "deployments/**/*.json"
+    "deployments/**/*.json",
+    "contracts/**/*.sol"
   ],
   "scripts": {
     "build:forge": "forge build",
@@ -33,26 +34,25 @@
     "@eth-optimism/core-utils": "^0.8.7",
     "@openzeppelin/contracts": "^4.5.0",
     "@openzeppelin/contracts-upgradeable": "^4.5.2",
-    "ethers": "^5.6.8",
-    "hardhat": "^2.9.6",
     "@rari-capital/solmate": "https://github.com/rari-capital/solmate.git#8f9b23f8838670afda0fd8983f2c41e8037ae6bc",
     "ds-test": "https://github.com/dapphub/ds-test.git#9310e879db8ba3ea6d5c6489a579118fd264a3f5",
+    "ethers": "^5.6.8",
     "forge-std": "https://github.com/foundry-rs/forge-std.git#564510058ab3db01577b772c275e081e678373f2",
+    "hardhat": "^2.9.6",
     "merkle-patricia-tree": "^4.2.4",
     "rlp": "^2.2.7"
   },
   "devDependencies": {
-    "@foundry-rs/hardhat-forge": "^0.1.7",
-    "command-exists": "1.2.9",
     "@eth-optimism/hardhat-deploy-config": "^0.2.0",
+    "@foundry-rs/hardhat-forge": "^0.1.7",
     "@nomiclabs/hardhat-ethers": "^2.0.0",
-    "@nomiclabs/hardhat-etherscan": "^2.1.3",
     "@nomiclabs/hardhat-waffle": "^2.0.0",
     "@typechain/ethers-v5": "^7.0.1",
     "@typechain/hardhat": "^2.3.0",
     "@typescript-eslint/eslint-plugin": "^5.26.0",
     "@typescript-eslint/parser": "^4.29.1",
     "chai": "^4.2.0",
+    "command-exists": "1.2.9",
     "dotenv": "^16.0.0",
     "ethereum-waffle": "^3.0.0",
     "ethers": "^5.6.8",

packages/contracts-periphery/.depcheckrc

 ignores: [
+  "@eth-optimism/contracts-bedrock",
   "@openzeppelin/contracts",
   "@openzeppelin/contracts-upgradeable",
   "@rari-capital/solmate",

packages/contracts-periphery/contracts/testing/helpers/ExternalContractCompiler.sol

+// SPDX-License-Identifier: MIT
+pragma solidity ^0.8.9;
+
+import { ProxyAdmin } from "@eth-optimism/contracts-bedrock/contracts/universal/ProxyAdmin.sol";
+import { Proxy } from "@eth-optimism/contracts-bedrock/contracts/universal/Proxy.sol";
+
+/**
+ * Just exists so we can compile external contracts.
+ */
+contract ExternalContractCompiler {
+
+}

packages/contracts-periphery/contracts/universal/op-erc721/OptimismMintableERC721Factory.sol

@@ -38,7 +38,7 @@ contract OptimismMintableERC721Factory is OwnableUpgradeable {
      * @param _bridge Address of the ERC721 bridge on this network.
      */
     constructor(address _bridge) {
-        intialize(_bridge);
+        initialize(_bridge);
     }
 
     /**
@@ -46,7 +46,7 @@ contract OptimismMintableERC721Factory is OwnableUpgradeable {
      *
      * @param _bridge Address of the ERC721 bridge on this network.
      */
-    function intialize(address _bridge) public reinitializer(VERSION) {
+    function initialize(address _bridge) public reinitializer(VERSION) {
         bridge = _bridge;
 
         // Initialize upgradable OZ contracts

packages/contracts-periphery/deploy/PeripheryProxyAdmin.ts

@@ -4,15 +4,19 @@ import { DeployFunction } from 'hardhat-deploy/dist/types'
 const deployFn: DeployFunction = async (hre) => {
   const { deployer } = await hre.getNamedAccounts()
 
-  const { deploy } = await hre.deployments.deterministic('ProxyAdmin', {
-    salt: hre.ethers.utils.solidityKeccak256(
-      ['string'],
-      ['PeripheryProxyAdmin']
-    ),
-    from: deployer,
-    args: [hre.deployConfig.ddd],
-    log: true,
-  })
+  const { deploy } = await hre.deployments.deterministic(
+    'PeripheryProxyAdmin',
+    {
+      contract: 'ProxyAdmin',
+      salt: hre.ethers.utils.solidityKeccak256(
+        ['string'],
+        ['PeripheryProxyAdmin']
+      ),
+      from: deployer,
+      args: [hre.deployConfig.ddd],
+      log: true,
+    }
+  )
 
   await deploy()
 }

packages/contracts-periphery/deploy/nft-bridge/L1ERC721BridgeProxy.ts

@@ -4,15 +4,19 @@ import { DeployFunction } from 'hardhat-deploy/dist/types'
 const deployFn: DeployFunction = async (hre) => {
   const { deployer } = await hre.getNamedAccounts()
 
-  const { deploy } = await hre.deployments.deterministic('Proxy', {
-    salt: hre.ethers.utils.solidityKeccak256(
-      ['string'],
-      ['L1ERC721BridgeProxy']
-    ),
-    from: deployer,
-    args: [hre.deployConfig.ddd],
-    log: true,
-  })
+  const { deploy } = await hre.deployments.deterministic(
+    'L1ERC721BridgeProxy',
+    {
+      contract: 'Proxy',
+      salt: hre.ethers.utils.solidityKeccak256(
+        ['string'],
+        ['L1ERC721BridgeProxy']
+      ),
+      from: deployer,
+      args: [hre.deployConfig.ddd],
+      log: true,
+    }
+  )
 
   await deploy()
 }

packages/contracts-periphery/deploy/nft-bridge/L2ERC721BridgeProxy.ts

@@ -4,15 +4,19 @@ import { DeployFunction } from 'hardhat-deploy/dist/types'
 const deployFn: DeployFunction = async (hre) => {
   const { deployer } = await hre.getNamedAccounts()
 
-  const { deploy } = await hre.deployments.deterministic('Proxy', {
-    salt: hre.ethers.utils.solidityKeccak256(
-      ['string'],
-      ['L2ERC721BridgeProxy']
-    ),
-    from: deployer,
-    args: [hre.deployConfig.ddd],
-    log: true,
-  })
+  const { deploy } = await hre.deployments.deterministic(
+    'L2ERC721BridgeProxy',
+    {
+      contract: 'Proxy',
+      salt: hre.ethers.utils.solidityKeccak256(
+        ['string'],
+        ['L2ERC721BridgeProxy']
+      ),
+      from: deployer,
+      args: [hre.deployConfig.ddd],
+      log: true,
+    }
+  )
 
   await deploy()
 }

packages/contracts-periphery/deploy/nft-bridge/OptimismMintableERC721FactoryProxy.ts

@@ -4,15 +4,19 @@ import { DeployFunction } from 'hardhat-deploy/dist/types'
 const deployFn: DeployFunction = async (hre) => {
   const { deployer } = await hre.getNamedAccounts()
 
-  const { deploy } = await hre.deployments.deterministic('Proxy', {
-    salt: hre.ethers.utils.solidityKeccak256(
-      ['string'],
-      ['OptimismMintableERC721FactoryProxy']
-    ),
-    from: deployer,
-    args: [hre.deployConfig.ddd],
-    log: true,
-  })
+  const { deploy } = await hre.deployments.deterministic(
+    'OptimismMintableERC721FactoryProxy',
+    {
+      contract: 'Proxy',
+      salt: hre.ethers.utils.solidityKeccak256(
+        ['string'],
+        ['OptimismMintableERC721FactoryProxy']
+      ),
+      from: deployer,
+      args: [hre.deployConfig.ddd],
+      log: true,
+    }
+  )
 
   await deploy()
 }

packages/contracts-periphery/hardhat.config.ts

@@ -80,13 +80,6 @@ const config: HardhatUserConfig = {
     deployConfig: './config/deploy',
   },
   deployConfigSpec: configSpec,
-  external: {
-    contracts: [
-      {
-        artifacts: '../contracts-bedrock/artifacts',
-      },
-    ],
-  },
   mocha: {
     timeout: 50000,
   },

packages/contracts-periphery/package.json

@@ -55,6 +55,7 @@
   "devDependencies": {
     "@defi-wonderland/smock": "^2.0.7",
     "@eth-optimism/contracts": "^0.5.28",
+    "@eth-optimism/contracts-bedrock": "^0.2.0",
     "@eth-optimism/core-utils": "^0.8.7",
     "@eth-optimism/hardhat-deploy-config": "^0.2.0",
     "@ethersproject/hardware-wallets": "^5.6.1",

yarn.lock

@@ -2582,19 +2582,6 @@
   resolved "https://registry.yarnpkg.com/@nomiclabs/hardhat-ethers/-/hardhat-ethers-2.0.2.tgz#c472abcba0c5185aaa4ad4070146e95213c68511"
   integrity sha512-6quxWe8wwS4X5v3Au8q1jOvXYEPkS1Fh+cME5u6AwNdnI4uERvPlVjlgRWzpnb+Rrt1l/cEqiNRH9GlsBMSDQg==
 
-"@nomiclabs/hardhat-etherscan@^2.1.3":
-  version "2.1.8"
-  resolved "https://registry.yarnpkg.com/@nomiclabs/hardhat-etherscan/-/hardhat-etherscan-2.1.8.tgz#e206275e96962cd15e5ba9148b44388bc922d8c2"
-  integrity sha512-0+rj0SsZotVOcTLyDOxnOc3Gulo8upo0rsw/h+gBPcmtj91YqYJNhdARHoBxOhhE8z+5IUQPx+Dii04lXT14PA==
-  dependencies:
-    "@ethersproject/abi" "^5.1.2"
-    "@ethersproject/address" "^5.0.2"
-    cbor "^5.0.2"
-    debug "^4.1.1"
-    fs-extra "^7.0.1"
-    node-fetch "^2.6.0"
-    semver "^6.3.0"
-
 "@nomiclabs/hardhat-etherscan@^3.0.1":
   version "3.0.4"
   resolved "https://registry.yarnpkg.com/@nomiclabs/hardhat-etherscan/-/hardhat-etherscan-3.0.4.tgz#b12e3e226a5b73c4a66d0e6943f948bd093b2711"
@@ -12866,7 +12853,7 @@ node-environment-flags@1.0.6:
     object.getownpropertydescriptors "^2.0.3"
     semver "^5.7.0"
 
-node-fetch@^2.6.0, node-fetch@^2.6.1, node-fetch@^2.6.7:
+node-fetch@^2.6.1, node-fetch@^2.6.7:
   version "2.6.7"
   resolved "https://registry.yarnpkg.com/node-fetch/-/node-fetch-2.6.7.tgz#24de9fba827e3b4ae44dc8b20256a379160052ad"
   integrity sha512-ZjMPFEfVx5j+y2yF35Kzx5sF7kDzxuDj6ziH4FFbOp87zKDZNx8yExJIb05OGF4Nlt9IHFIMBkRl41VdvcNdbQ==