Merge pull request #113 from threshold-network/goerli-deployment

Görli contracts deployment

Görli became a recommended test network after Ropsten's deprecation notice (link).

In this PR we update deployment scripts and configuration to support Görli.

The contracts were already deployed to Görli: @threshold-network/[email protected]

@cygnusv please note that we deploy stubs for NuCypherStakingEscrow and NuCypherToken contracts. We can use real implementations once the contracts are deployed.

Author: michalinacienciala

deploy/00_resolve_nucypher_staking_escrow.ts

@@ -24,9 +24,10 @@ const func: DeployFunction = async function (hre: HardhatRuntimeEnvironment) {
     // Save deployment artifact of external contract to include it in the package.
     await deployments.save("NuCypherStakingEscrow", NuCypherStakingEscrow)
   } else if (
-    // TODO: For ropsten currently we deploy a stub contract. We should consider
+    // TODO: For testnets currently we deploy a stub contract. We should consider
     // switching to an actual contract.
     hre.network.name !== "ropsten" &&
+    hre.network.name !== "goerli" &&
     (!hre.network.tags.allowStubs ||
       (hre.network.config as HardhatNetworkConfig)?.forking?.enabled)
   ) {

deploy/00_resolve_nucypher_token.ts

@@ -19,9 +19,10 @@ const func: DeployFunction = async function (hre: HardhatRuntimeEnvironment) {
     // Save deployment artifact of external contract to include it in the package.
     await deployments.save("NuCypherToken", NuCypherToken)
   } else if (
-    // TODO: For ropsten currently we deploy a stub contract. We should consider
+    // TODO: For testnets currently we deploy a stub contract. We should consider
     // switching to an actual contract.
     hre.network.name !== "ropsten" &&
+    hre.network.name !== "goerli" &&
     (!hre.network.tags.allowStubs ||
       (hre.network.config as HardhatNetworkConfig)?.forking?.enabled)
   ) {

deploy/07_deploy_token_staking.ts

@@ -25,6 +25,7 @@ const func: DeployFunction = async function (hre: HardhatRuntimeEnvironment) {
   ]
   const tokenStakingInitializerArgs = []
 
+  // TODO: Consider upgradable deployment also for goerli.
   let tokenStakingAddress
   if (hre.network.name == "mainnet") {
     const TokenStaking = await ethers.getContractFactory("TokenStaking")

docs/rfc-2-vending-machine.adoc

@@ -109,3 +109,21 @@ The vending machine contracts are not upgradeable.
 * NU Staking Escrow address: `0x25C5aF106C04e17d7097617C5d74e23717Fb6286`
 * Keep Stake address: `0xE53eC3b651EEFA922dCc80c70426764aF4F7eFC0`
 * Token Staking address: `0x7149bC2d6f090fBcdc44303F0752ae34d77f6D71`
+
+=== Görli Testnet
+
+The most recent package deployed to Görli is published to the npm Registry
+and tagged with _goerli_ (`@threshold-network/solidity-contracts@goerli`).
+
+Currently it is: `@threshold-network/[email protected]`.
+
+Contracts addresses:
+
+* NU<>T Vending Machine address: `0x413ff6Bb6E12df17d99C1b12CbeD276c51EAc900`
+* KEEP<>T Vending Machine address: `0xBb9b1E617d739ec3034537A48f8cB62f80a181C5`
+* T token address: `0x0f092E3bd92751FDAe3765BCE3F6AeBe5881C499`
+* NU token address: `0x805336B10809e945302F6DdcDD07E61ecDfB2E08`
+* KEEP token address: `0x22647FfAe391540d584599818CA22fdF18890753`
+* NU Staking Escrow address: `0xAD83f62aD063B5af9F9E3F2F6772108473C0F03B`
+* Keep Stake address: `0xe65E4C75df3c446F477A0f1F2909Fc2c49d5e238`
+* Token Staking address: `0x0754935436b7DC24b62Bc8a01054A108A784d0f8`

hardhat.config.ts

@@ -45,6 +45,17 @@ const config: HardhatUserConfig = {
       chainId: 1101,
       tags: ["allowStubs"],
     },
+    goerli: {
+      url: process.env.CHAIN_API_URL || "",
+      chainId: 5,
+      accounts: process.env.CONTRACT_OWNER_ACCOUNT_PRIVATE_KEY
+        ? [
+            process.env.CONTRACT_OWNER_ACCOUNT_PRIVATE_KEY,
+            process.env.KEEP_CONTRACT_OWNER_ACCOUNT_PRIVATE_KEY,
+          ]
+        : undefined,
+      tags: ["tenderly"],
+    },
     rinkeby: {
       url: process.env.CHAIN_API_URL || "",
       chainId: 4,
@@ -100,6 +111,7 @@ const config: HardhatUserConfig = {
       // dependencies.
       // development: ["external/npm/@keep-network/keep-core/artifacts"],
       ropsten: ["external/npm/@keep-network/keep-core/artifacts"],
+      goerli: ["external/npm/@keep-network/keep-core/artifacts"],
       mainnet: ["./external/mainnet"],
     },
   },
@@ -114,6 +126,7 @@ const config: HardhatUserConfig = {
     keepRegistryKeeper: {
       default: 0, // same as the deployer
       ropsten: "0x923C5Dbf353e99394A21Aa7B67F3327Ca111C67D",
+      goerli: "0x68ad60CC5e8f3B7cC53beaB321cf0e6036962dBc",
     },
   },
   mocha: {

package.json

@@ -14,6 +14,7 @@
     "export.json"
   ],
   "scripts": {
+    "clean": "hardhat clean && rm -rf cache/ deployments/ export/ external/npm export.json",
     "build": "hardhat compile",
     "deploy": "hardhat deploy --export export.json",
     "format": "npm run lint && prettier --check .",
@@ -28,10 +29,10 @@
     "test:system": "NODE_ENV=system-test hardhat test ./test/system/*.test.js",
     "postinstall": "./scripts/prepare-dependencies.sh $INIT_CWD",
     "prepack": "tsc -p tsconfig.export.json && hardhat export-artifacts export/artifacts",
-    "prepublishOnly": "./scripts/prepare-artifacts.sh --network $npm_config_network"
+    "prepublishOnly": "hardhat prepare-artifacts --network $npm_config_network"
   },
   "devDependencies": {
-    "@keep-network/hardhat-helpers": "^0.4.1-pre.2",
+    "@keep-network/hardhat-helpers": "^0.6.0-pre.8",
     "@keep-network/prettier-config-keep": "github:keep-network/prettier-config-keep#d6ec02e",
     "@nomiclabs/hardhat-ethers": "^2.0.2",
     "@nomiclabs/hardhat-waffle": "^2.0.1",
@@ -64,6 +65,6 @@
     "@thesis/solidity-contracts": "github:thesis/solidity-contracts#4985bcf"
   },
   "peerDependencies": {
-    "@keep-network/keep-core": ">1.8.0-dev <1.8.0-pre"
+    "@keep-network/keep-core": ">1.8.1-dev <1.8.1-pre"
   }
 }

scripts/prepare-artifacts.sh

@@ -564,10 +564,10 @@
   resolved "https://registry.yarnpkg.com/@humanwhocodes/object-schema/-/object-schema-1.2.1.tgz#b520529ec21d8e5945a1851dfd1c32e94e39ff45"
   integrity sha512-ZnQMnLV4e7hDlUvw8H+U8ASL02SS2Gn6+9Ac3wGGLIe7+je2AeAOxPY+izIPJDfFDb7eDjev0Us8MO1iFRN8hA==
 
-"@keep-network/hardhat-helpers@^0.4.1-pre.2":
-  version "0.4.1-pre.2"
-  resolved "https://registry.yarnpkg.com/@keep-network/hardhat-helpers/-/hardhat-helpers-0.4.1-pre.2.tgz#4c03b7bf52d28378383dbcbd94d9fd3dc3bfbf70"
-  integrity sha512-Mkgy4yD3ZVvyDshejFLTJU2+APX0w1RL9CFDH5P8ulhlzuSfwr07oo7VO2Bqw4WUuM879Rmfnmy1Ffwn/tnzyQ==
+"@keep-network/hardhat-helpers@^0.6.0-pre.8":
+  version "0.6.0-pre.8"
+  resolved "https://registry.yarnpkg.com/@keep-network/hardhat-helpers/-/hardhat-helpers-0.6.0-pre.8.tgz#6e0722889a0132dabed5182fb32f6424ff4a77d0"
+  integrity sha512-51oLHceBubutBYxfVk2pLjgyhvpcDC1ahKM3V9lOiTa9lbWyY18Dza7rnM9V04kq+8DbweQRM0M9/f+K26nl9g==
 
 "@keep-network/keep-core@>1.8.1-dev <1.8.1-pre":
   version "1.8.1-dev.0"