feat: Add hardhat deployment infrastructure

packages/common/browser.js

@@ -17,5 +17,6 @@ module.exports = {
   ...require("./src/TimeUtils"),
   ...require("./src/VotingUtils"),
   ...require("./src/PriceIdentifierUtils"),
-  ...require("./src/MultiVersionTestHelpers.js")
+  ...require("./src/MultiVersionTestHelpers.js"),
+  ...require("./src/Ethers.js")
 };

packages/common/src/Constants.js

@@ -9,7 +9,8 @@ const interfaceName = {
   FundingRateStore: "FundingRateStore",
   OptimisticOracle: "OptimisticOracle",
   Bridge: "Bridge",
-  GenericHandler: "GenericHandler"
+  GenericHandler: "GenericHandler",
+  MockOracleAncillary: "Oracle"
 };
 
 module.exports = {

packages/common/src/Ethers.js

@@ -0,0 +1,20 @@
+const { hexlify, toUtf8Bytes } = require("ethers/utils");
+
+function stringToBytes32(text) {
+  let result = toUtf8Bytes(text);
+  if (result.length > 32) {
+    throw new Error("String too long");
+  }
+  result = hexlify(result);
+  while (result.length < 66) {
+    result += "0";
+  }
+  if (result.length !== 66) {
+    throw new Error("invalid web3 implicit bytes32");
+  }
+  return result;
+}
+
+module.exports = {
+  stringToBytes32
+};

packages/common/src/PublicNetworks.js

@@ -20,6 +20,10 @@ const PublicNetworks = {
     daiAddress: "0x5592EC0cfb4dbc12D3aB100b257153436a1f0FEa",
     wethAddress: "0xc778417E063141139Fce010982780140Aa0cD5Ab"
   },
+  5: {
+    name: "goerli",
+    etherscan: "https://goerli.etherscan.io/"
+  },
   42: {
     name: "kovan",
     ethFaucet: "https://faucet.kovan.network/",

packages/common/src/TruffleConfig.js

@@ -39,11 +39,14 @@ const gasPx = argv.gasPrice ? Web3.utils.toWei(argv.gasPrice, "gwei") : 20000000
 const gas = undefined; // Defining this as undefined (rather than leaving undefined) forces truffle estimate gas usage.
 
 // If a custom node URL is provided, use that. Otherwise use an infura websocket connection.
-function getNodeUrl(networkName) {
+function getNodeUrl(networkName, useHttps = false) {
   if (isPublicNetwork(networkName) && !networkName.includes("fork")) {
     const infuraApiKey = process.env.INFURA_API_KEY || "e34138b2db5b496ab5cc52319d2f0299";
     const name = networkName.split("_")[0];
-    return process.env.CUSTOM_NODE_URL || `wss://${name}.infura.io/ws/v3/${infuraApiKey}`;
+    return (
+      process.env.CUSTOM_NODE_URL ||
+      (useHttps ? `https://${name}.infura.io/v3/${infuraApiKey}` : `wss://${name}.infura.io/ws/v3/${infuraApiKey}`)
+    );
   }
 
   const port = process.env.CUSTOM_LOCAL_NODE_PORT || "9545";
@@ -212,4 +215,4 @@ function getTruffleConfig(truffleContextDir = "./") {
   };
 }
 
-module.exports = { getTruffleConfig, getNodeUrl };
+module.exports = { getTruffleConfig, getNodeUrl, mnemonic };

packages/core/.gitignore

@@ -3,3 +3,4 @@ artifacts/
 flattened/
 types/
 contract-types/
+deployments/

packages/core/README.md

@@ -70,6 +70,48 @@ const governor = await governor.deployed();
 Note: this use case is not particularly common, but it is sometimes useful to have access to multiple abi versions
 side-by-side.
 
+## Deployment with Hardhat
+
+Here is a list of scripts you can execute:
+
+`yarn void:deploy`
+
+This will deploy your contracts on the in-memory hardhat network and exit, leaving no trace. Quickest way to ensure that deployments work as intended without consequences.
+
+`yarn hardhat deploy --network <NETWORK-NAME> --tags <TAGS>`
+
+Deploy all contracts to specified network. Requires a `CUSTOM_NODE_URL` HTTP(s) endpoint and a `MNEMONIC` to be set in environment. Available contract tags can be found in `/deploy` scripts, and available networks are found in the `networks` object within `hardhat.config.js`. Tags can be powerful, for example running `yarn hardhat deploy --tags Bridge` will only deploy the Bridge contract its dependencies (such as the Finder).
+
+`yarn hardhat deploy --tags dvm`
+
+Deploys all production DVM contracts, which doesn't include the `MockOracle` or BeaconOracles for example.
+
+`yarn hardhat deploy --tags sink-oracle <NETWORK-NAME>`
+
+Deploys minimum contracts necessary to set up Sink Oracle on L2 on the network, which would be used to deploy to Polygon for example.
+
+`yarn hardhat deploy --tags source-oracle,test <NETWORK-NAME>`
+
+Deploys minimum contracts necessary to set up Source Oracle on L1 on the network, along with test-specific versions of contracts, like the MockOracle intead of Voting.
+
+`./scripts/hardhat/verifyDeployedContracts.sh <NETWORK-NAME>`
+
+Verify contracts for selected network on Etherscan. Requires an `ETHERSCAN_API_KEY` to be set in environment. This script requires that the local `./core/deployments` has solc standard-input json files, which will be generated after running the `deploy` command.
+
+`yarn hardhat export --export-all ./networks/hardhat/deployed.json`
+
+Export deployed contract data such as ABI and addresses to `deployed.json` in order to make data available for a front-end client, for example. For example, a newly deployed `Finder` address on Rinkeby can be imported via `deployed.4.rinkeby.contracts.Finder.address`.
+
+The following commands are implemented as [hardhat tasks](https://hardhat.org/guides/create-task.html) that make it easy to interact with deployed contracts via the CLI:
+
+`yarn hardhat register-deployer --network <NETWORK-NAME>`
+
+Registers the `deployer` account (as defined in the `namedAccounts` param in `hardhat.config.js`) with the deployed Registry for the network.
+
+`yarn hardhat setup-finder --registry --bridge --generichandler --network <NETWORK-NAME>`
+
+Sets specified contracts in the deployed Finder. More contracts available to be set can be found in the `core/scripts/hardhat/tasks/finder.js` script.
+
 ## Typescript!
 
 In addition to the above import styles, you can import typescript types for truffle, ethers, and web3. Because of existing

packages/core/deploy/001_deploy_finder.js

@@ -0,0 +1,14 @@
+const func = async function(hre) {
+  const { deployments, getNamedAccounts } = hre;
+  const { deploy } = deployments;
+
+  const { deployer } = await getNamedAccounts();
+
+  await deploy("Finder", {
+    from: deployer,
+    args: [],
+    log: true
+  });
+};
+module.exports = func;
+func.tags = ["Finder", "dvm", "sink-oracle", "source-oracle"];

packages/core/deploy/002_deploy_registry.js

@@ -0,0 +1,29 @@
+const { stringToBytes32, interfaceName } = require("@uma/common");
+const func = async function(hre) {
+  const { deployments, getNamedAccounts } = hre;
+  const { deploy, log, execute } = deployments;
+
+  const { deployer } = await getNamedAccounts();
+
+  const deployResult = await deploy("Registry", {
+    from: deployer,
+    args: [],
+    log: true
+  });
+
+  if (deployResult.newlyDeployed) {
+    const txn = await execute(
+      "Finder",
+      { from: deployer },
+      "changeImplementationAddress",
+      stringToBytes32(interfaceName.Registry),
+      deployResult.address
+    );
+    log(
+      `Set ${interfaceName.Bridge} in Finder to deployed instance @ ${deployResult.address}, tx: ${txn.transactionHash}`
+    );
+  }
+};
+module.exports = func;
+func.tags = ["Registry", "dvm", "sink-oracle", "source-oracle"];
+func.dependencies = ["Finder"];

packages/core/deploy/003_deploy_bridge.js

@@ -0,0 +1,38 @@
+const { stringToBytes32, interfaceName } = require("@uma/common");
+const func = async function(hre) {
+  const { deployments, getNamedAccounts, getChainId } = hre;
+  const { deploy, log, execute } = deployments;
+
+  const { deployer } = await getNamedAccounts();
+
+  const chainId = await getChainId();
+
+  const args = [
+    chainId, // Current chain ID.
+    [deployer], // Initial relayers defaults to deployer as 1 of 1
+    1, // Relayer threshold set to 1
+    0, // Deposit fee
+    100 // # of blocks after which a proposal expires
+  ];
+  const deployResult = await deploy("Bridge", {
+    from: deployer,
+    args,
+    log: true
+  });
+
+  if (deployResult.newlyDeployed) {
+    const txn = await execute(
+      "Finder",
+      { from: deployer },
+      "changeImplementationAddress",
+      stringToBytes32(interfaceName.Bridge),
+      deployResult.address
+    );
+    log(
+      `Set ${interfaceName.Bridge} in Finder to deployed instance @ ${deployResult.address}, tx: ${txn.transactionHash}`
+    );
+  }
+};
+module.exports = func;
+func.tags = ["Bridge", "sink-oracle", "source-oracle"];
+func.dependencies = ["Finder"];

packages/core/deploy/004_deploy_generic_handler.js

@@ -0,0 +1,32 @@
+const { stringToBytes32, interfaceName } = require("@uma/common");
+const func = async function(hre) {
+  const { deployments, getNamedAccounts } = hre;
+  const { deploy, log, execute } = deployments;
+
+  const { deployer } = await getNamedAccounts();
+
+  const Bridge = await deployments.get("Bridge");
+
+  const args = [Bridge.address, [], [], [], []];
+  const deployResult = await deploy("GenericHandler", {
+    from: deployer,
+    args,
+    log: true
+  });
+
+  if (deployResult.newlyDeployed) {
+    const txn = await execute(
+      "Finder",
+      { from: deployer },
+      "changeImplementationAddress",
+      stringToBytes32(interfaceName.GenericHandler),
+      deployResult.address
+    );
+    log(
+      `Set ${interfaceName.GenericHandler} in Finder to deployed instance @ ${deployResult.address}, tx: ${txn.transactionHash}`
+    );
+  }
+};
+module.exports = func;
+func.tags = ["GenericHandler", "sink-oracle", "source-oracle"];
+func.dependencies = ["Bridge", "Finder"];

packages/core/deploy/005_deploy_sink_oracle.js

@@ -0,0 +1,27 @@
+require("dotenv").config();
+// Default source oracle chain ID is 1, corresponding to the mainnet network.
+const SOURCE_ORACLE_CHAIN_ID = process.env.SOURCE_ORACLE_CHAIN_ID || 1;
+
+const func = async function(hre) {
+  const { deployments, getNamedAccounts, getChainId } = hre;
+  const { deploy } = deployments;
+
+  const { deployer } = await getNamedAccounts();
+
+  const chainId = await getChainId();
+  const Finder = await deployments.get("Finder");
+
+  const args = [
+    Finder.address,
+    chainId, // Current chain ID.
+    SOURCE_ORACLE_CHAIN_ID // Chain ID where SourceOracle is located that this SinkOracle will make price requests to.
+  ];
+  await deploy("SinkOracle", {
+    from: deployer,
+    args,
+    log: true
+  });
+};
+module.exports = func;
+func.tags = ["SinkOracle", "sink-oracle"];
+func.dependencies = ["Finder"];

packages/core/deploy/006_deploy_source_oracle.js

@@ -0,0 +1,22 @@
+const func = async function(hre) {
+  const { deployments, getNamedAccounts, getChainId } = hre;
+  const { deploy } = deployments;
+
+  const { deployer } = await getNamedAccounts();
+
+  const chainId = await getChainId();
+  const Finder = await deployments.get("Finder");
+
+  const args = [
+    Finder.address,
+    chainId // Current chain ID.
+  ];
+  await deploy("SourceOracle", {
+    from: deployer,
+    args,
+    log: true
+  });
+};
+module.exports = func;
+func.tags = ["SourceOracle", "source-oracle"];
+func.dependencies = ["Finder"];

packages/core/deploy/007_identifier_whitelist.js

@@ -0,0 +1,29 @@
+const { stringToBytes32, interfaceName } = require("@uma/common");
+const func = async function(hre) {
+  const { deployments, getNamedAccounts } = hre;
+  const { deploy, log, execute } = deployments;
+
+  const { deployer } = await getNamedAccounts();
+
+  const deployResult = await deploy("IdentifierWhitelist", {
+    from: deployer,
+    args: [],
+    log: true
+  });
+
+  if (deployResult.newlyDeployed) {
+    const txn = await execute(
+      "Finder",
+      { from: deployer },
+      "changeImplementationAddress",
+      stringToBytes32(interfaceName.IdentifierWhitelist),
+      deployResult.address
+    );
+    log(
+      `Set ${interfaceName.IdentifierWhitelist} in Finder to deployed instance @ ${deployResult.address}, tx: ${txn.transactionHash}`
+    );
+  }
+};
+module.exports = func;
+func.tags = ["IdentifierWhitelist", "dvm"];
+func.dependencies = ["Finder"];

packages/core/deploy/008_mock_oracle.js

@@ -0,0 +1,33 @@
+const { stringToBytes32, interfaceName, ZERO_ADDRESS } = require("@uma/common");
+
+const func = async function(hre) {
+  const { deployments, getNamedAccounts } = hre;
+  const { deploy, log, execute } = deployments;
+
+  const { deployer } = await getNamedAccounts();
+
+  const Finder = await deployments.get("Finder");
+
+  const args = [Finder.address, ZERO_ADDRESS];
+  const deployResult = await deploy("MockOracleAncillary", {
+    from: deployer,
+    args,
+    log: true
+  });
+
+  if (deployResult.newlyDeployed) {
+    const txn = await execute(
+      "Finder",
+      { from: deployer },
+      "changeImplementationAddress",
+      stringToBytes32(interfaceName.MockOracleAncillary),
+      deployResult.address
+    );
+    log(
+      `Set ${interfaceName.MockOracleAncillary} in Finder to deployed instance @ ${deployResult.address}, tx: ${txn.transactionHash}`
+    );
+  }
+};
+module.exports = func;
+func.tags = ["MockOracle", "test"];
+func.dependencies = ["Finder", "IdentifierWhitelist"];