Create contracts deployment scripts

This commit introduces a deployment script based on the
[hardhat-deploy](https://github.com/wighawag/hardhat-deploy) plugin.
To deploy all contracts on the given network, the following command can
be used:
```
yarn deploy --network <network>
```
If contracts haven't been built yet or changes occurred, this task will
build the contracts before running the deployment script. Once the
deployment terminates, a new `deployments` directory containing all
deployment info will be created. It can be directly used by dApps or
other client code as it contains deployment details like chain ID,
transaction hash, ABI or address for each contract. There is also a
possibility to run the deployment with export mode enabled:
```
yarn deploy --network <network> --export ./export.json
```
This command produces a handy summary file containing deployment info
for all contracts in one place. However, it doesn't contain the
deployment transaction hash making it inappropriate for some use cases
relying on this field.

The deployment script is divided into multiple sub-scripts placed in the
`deploy` directory. It uses the
[tags and dependencies](https://github.com/wighawag/hardhat-deploy#deploy-scripts-tags-and-dependencies)
feature provided by the `hardhat-deploy` plugin. Such a structure
allows running arbitrary parts of the entire deployment by using the tag
mechanism. For example, to deploy only the `VendingMachine` contract (with
their dependencies), the following command can be used:
```
yarn deploy --network localhost --tags VendingMachine
```
Multiple deployment sub-scripts also improves the readability and allows
specifying dependencies between components in an explicit way.

Author: michalinacienciala

.gitignore

@@ -1,5 +1,16 @@
 node_modules/
+
 artifacts/
+build/
 cache/
+deployments/
+export.json
+
 typechain/
+
+yarn-error.log
+
 .vscode/
+
+.hardhat/*
+!.hardhat/networks_TEMPLATE.ts

.hardhat/networks_TEMPLATE.ts

@@ -0,0 +1,25 @@
+// This is a template file. The file should be renamed to `networks.ts` and updated
+// with valid data. The properties will overwrite the ones defined in hardhat
+// project config file if hardhat.config.ts file contains `localNetworksConfig` property
+// pointing to this file.
+
+import { LocalNetworksConfig } from "@keep-network/hardhat-local-networks-config"
+
+const config: LocalNetworksConfig = {
+  networks: {
+    ropsten: {
+      url: "url not set",
+      from: "address not set",
+      accounts: ["private key not set"],
+      tags: ["tenderly"],
+    },
+    mainnet: {
+      url: "url not set",
+      from: "address not set",
+      accounts: ["private key not set"],
+      tags: ["tenderly"],
+    },
+  },
+}
+
+module.exports = config

README.adoc

@@ -0,0 +1,51 @@
+:toc: macro
+
+= Threshold network contracts
+
+This package contains Threshold network contracts.
+
+toc::[]
+
+== Build, test and deploy
+
+Threshold contracts use https://hardhat.org/[*Hardhat*] development environment.
+To build and deploy these contracts, please follow the instructions presented
+below.
+
+=== Prerequisites
+
+Please make sure you have the following prerequisites installed on your machine:
+
+- https://nodejs.org[Node.js] >14.17.4
+- https://yarnpkg.com[Yarn] >1.22.10
+
+=== Build contracts
+
+To build the smart contracts, install node packages first:
+```
+yarn install
+```
+Once packages are installed, you can build the smart contracts using:
+```
+yarn build
+```
+Compiled contracts will land in the `build` directory.
+
+=== Test contracts
+
+There are multiple test scenarios living in the `test` directory.
+You can run them by doing:
+```
+yarn test
+```
+
+=== Deploy contracts
+
+To deploy all contracts on the given network, please run:
+```
+yarn deploy --network <network>
+```
+
+If contracts haven't been built yet or changes occurred, this task will build
+the contracts before running the deployment script. This command produces
+an `export.json` file containing contract deployment info.

README.md

@@ -58,7 +58,7 @@ contract T is ERC20WithPermit, MisfundRecovery, Checkpoints {
                     abi.encode(
                         DELEGATION_TYPEHASH,
                         delegatee,
-                        nonces[signatory]++,
+                        nonce[signatory]++,
                         deadline
                     )
                 )

contracts/token/T.sol

@@ -0,0 +1,41 @@
+import { HardhatRuntimeEnvironment, HardhatNetworkConfig } from "hardhat/types"
+import { DeployFunction } from "hardhat-deploy/types"
+import { BigNumber } from "ethers"
+
+const func: DeployFunction = async function (hre: HardhatRuntimeEnvironment) {
+  const { getNamedAccounts, deployments, helpers } = hre
+  const { log } = deployments
+  const { deployer } = await getNamedAccounts()
+  const { execute } = deployments
+
+  const KeepToken = await deployments.getOrNull("KeepToken")
+
+  if (KeepToken && helpers.address.isValid(KeepToken.address)) {
+    log(`using external KeepToken at ${KeepToken.address}`)
+  } else if (
+    hre.network.name !== "hardhat" ||
+    (hre.network.config as HardhatNetworkConfig).forking.enabled
+  ) {
+    throw new Error("deployed KeepToken contract not found")
+  } else {
+    log(`deploying KeepToken stub`)
+
+    await deployments.deploy("KeepToken", {
+      contract: "TestToken",
+      from: deployer,
+      log: true,
+    })
+
+    await execute(
+      "KeepToken",
+      { from: deployer },
+      "mint",
+      deployer,
+      BigNumber.from(10).pow(27)
+    )
+  }
+}
+
+export default func
+
+func.tags = ["KeepToken"]

deploy/00_resolve_keep_token.ts

@@ -0,0 +1,33 @@
+import { HardhatRuntimeEnvironment } from "hardhat/types"
+import { DeployFunction } from "hardhat-deploy/types"
+import { BigNumber } from "ethers"
+
+const func: DeployFunction = async function (hre: HardhatRuntimeEnvironment) {
+  const { getNamedAccounts, deployments } = hre
+  const { deployer } = await getNamedAccounts()
+  const { execute } = deployments
+
+  const T = await deployments.deploy("T", {
+    from: deployer,
+    log: true,
+  })
+
+  await execute(
+    "T",
+    { from: deployer },
+    "mint",
+    deployer,
+    BigNumber.from("10000000000000000000000000000")
+  )
+
+  if (hre.network.tags.tenderly) {
+    await hre.tenderly.verify({
+      name: "T",
+      address: T.address,
+    })
+  }
+}
+
+export default func
+
+func.tags = ["T"]

deploy/01_deploy_t.ts

@@ -0,0 +1,32 @@
+import { HardhatRuntimeEnvironment } from "hardhat/types"
+import { DeployFunction } from "hardhat-deploy/types"
+
+const func: DeployFunction = async function (hre: HardhatRuntimeEnvironment) {
+  const { getNamedAccounts, deployments } = hre
+  const { deployer } = await getNamedAccounts()
+  const { execute } = deployments
+
+  const KeepToken = await deployments.get("KeepToken")
+  const T = await deployments.get("T")
+
+  const vendingMachine = await deployments.deploy("VendingMachine", {
+    from: deployer,
+    args: [KeepToken.address, T.address, 1000000000, 10000000000],
+    log: true,
+  })
+
+  if (hre.network.tags.tenderly) {
+    await hre.tenderly.verify({
+      name: "VendingMachine",
+      address: vendingMachine.address,
+    })
+  }
+}
+
+export default func
+
+func.tags = ["VendingMachine"]
+func.dependencies = [
+  "T",
+  "KeepToken",
+]

deploy/02_deploy_vending_machine.ts

@@ -0,0 +1,26 @@
+import { HardhatRuntimeEnvironment } from "hardhat/types"
+import { DeployFunction } from "hardhat-deploy/types"
+import { BigNumber } from "ethers"
+
+const func: DeployFunction = async function (hre: HardhatRuntimeEnvironment) {
+  const { getNamedAccounts, deployments } = hre
+  const { deployer } = await getNamedAccounts()
+  const { execute } = deployments
+
+  const VendingMachine = await deployments.get("VendingMachine")
+
+  await execute(
+    "T",
+    { from: deployer },
+    "transfer",
+    VendingMachine.address,
+    BigNumber.from("4500000000000000000000000000")
+  )
+}
+
+export default func
+
+func.tags = ["TransferT"]
+func.dependencies = [
+  "VendingMachine",
+]