feat: added support for multiple chains

hbarcelos · hbarcelos · commit 079b1020889c · 2021-09-03T10:50:50.000-03:00
diff --git a/.eslintrc.json b/.eslintrc.json
@@ -34,5 +34,14 @@
         "commonjs": true
       }
     ]
-  }
+  },
+  "overrides": [
+    {
+      "files": "*.json",
+      "extends": "plugin:json/recommended",
+      "plugins": [
+        "json"
+      ]
+    }
+  ]
 }
diff --git a/contracts/bin/flatten.sh b/contracts/bin/flatten.sh
@@ -0,0 +1,3 @@
+#!/bin/bash
+# npx hardhat flatten src/MerkleRedeem.sol 2> /dev/null | awk '/SPDX-License-Identifier/&&c++>0 {next} 1' | awk '/pragma experimental ABIEncoderV2;/&&c++>0 {next} 1'
+npx hardhat flatten src/MerkleRedeem.sol 2> /dev/null
diff --git a/contracts/deploy/01-merkleRedeem.js b/contracts/deploy/01-merkleRedeem.js
@@ -5,6 +5,9 @@ const paramsByChainId = {
   1: {
     pnkAddress: "0x93ED3FBe21207Ec2E8f2d3c3de6e058Cb73Bc04d",
   },
+  100: {
+    pnkAddress: "0xcb3231aBA3b451343e0Fddfc45883c842f223846",
+  },
 };
 
 module.exports = async function deployMerkleRedeem({ deployments, getNamedAccounts, getChainId }) {
diff --git a/contracts/deployments/xdai/.chainId b/contracts/deployments/xdai/.chainId
@@ -0,0 +1 @@
+100
diff --git a/contracts/deployments/xdai/MerkleRedeem.json b/contracts/deployments/xdai/MerkleRedeem.json
diff --git a/contracts/hardhat.config.js b/contracts/hardhat.config.js
@@ -34,7 +34,15 @@ module.exports = {
     mainnet: {
       chainId: 1,
       url: `https://mainnet.infura.io/v3/${process.env.INFURA_API_KEY}`,
-      accounts: [process.env.MAINNET_DEPLOYER_PRIVATE_KEY],
+      accounts: [process.env.PRODUCTION_DEPLOYER_PRIVATE_KEY],
+      live: true,
+      saveDeployments: true,
+      tags: ["production"],
+    },
+    xdai: {
+      chainId: 100,
+      url: "https://rpc.xdaichain.com",
+      accounts: [process.env.PRODUCTION_DEPLOYER_PRIVATE_KEY],
       live: true,
       saveDeployments: true,
       tags: ["production"],
diff --git a/contracts/package.json b/contracts/package.json
@@ -9,7 +9,8 @@
     "build": "hardhat compile",
     "deploy": "hardhat deploy",
     "deploy:kovan": "hardhat deploy --network kovan",
-    "deploy:mainnet": "hardhat deploy --network mainnet"
+    "deploy:mainnet": "hardhat deploy --network mainnet",
+    "deploy:xdai": "hardhat deploy --network xdai"
   },
   "dependencies": {
     "@openzeppelin/contracts": "^3.4.0"
@@ -20,7 +21,7 @@
     "dotenv-safe": "^8.2.0",
     "ethereum-waffle": "^3.2.2",
     "ethers": "^5.0.29",
-    "hardhat": "^2.0.9",
+    "hardhat": "^2.6.2",
     "hardhat-deploy": "^0.7.0-beta.44",
     "hardhat-deploy-ethers": "^0.3.0-beta.7"
   }
diff --git a/snapshots/.env.example b/snapshots/.env.example
@@ -1,9 +1,11 @@
 PNK_DROP_CHAIN_ID='<number>'
 PNK_DROP_KLEROS_LIQUID_ADDRESS='<address>'
-# Ideally the block which KlerosLiquid contract was deployed to
-PNK_DROP_FROM_BLOCK='<block number>'
 PNK_DROP_AMOUNT='<amount of tokens to distibute>'
 PNK_DROP_PERIOD='<number>'
+
+# Either provide this
+PNK_DROP_JSON_RPC_URL='<string>'
+# Or these
 PNK_DROP_INFURA_API_KEY='<API key>'
 PNK_DROP_ETHERSCAN_API_KEY='<API key>'
 PNK_DROP_ALCHEMY_API_KEY='<API key>'
diff --git a/snapshots/cli.js b/snapshots/cli.js
@@ -12,9 +12,6 @@ dotenv.config();
 
 dayjs.extend(utc);
 
-const etherscanApiKey = process.env.PNK_DROP_ETHERSCAN_API_KEY;
-const alchemyApiKey = process.env.PNK_DROP_ALCHEMY_API_KEY;
-
 const argv = yargs(hideBin(process.argv))
   .env("PNK_DROP")
   .strict(true)
@@ -59,6 +56,9 @@ const argv = yargs(hideBin(process.argv))
   .option("to-block", {
     description: "The block to end the query for events",
   })
+  .option("json-rpc-url", {
+    description: "The JSON RPC URL to connect to",
+  })
   .option("infura-api-key", {
     description: "The Infura API key",
   })
@@ -76,7 +76,8 @@ const argv = yargs(hideBin(process.argv))
   })
   .demand(["kleros-liquid-address", "period", "amount", "chain-id", "start-date", "end-date"])
   .boolean(["save-s3", "save-local", "save-ipfs"])
-  .string(["kleros-liquid-address", "infura-api-key", "etherscan-api-key", "alchemy-api-key"])
+  .string(["kleros-liquid-address", "json-rpc-url", "infura-api-key", "etherscan-api-key", "alchemy-api-key"])
+  .conflicts("json-rpc-url", ["infura-api-key", "etherscan-api-key", "alchemy-api-key"])
   .number(["chain-id", "from-block", "to-block", "period"])
   .coerce(["amount"], (value) => utils.parseEther(String(value)))
   .coerce(["start-date"], (value) => dayjs.utc(value).startOf("day"))
@@ -104,16 +105,21 @@ const {
   startDate,
   endDate,
   fromBlock,
+  jsonRpcUrl,
   infuraApiKey,
+  etherscanApiKey,
+  alchemyApiKey,
 } = normalizeArgs(argv);
 
 endDate.isBefore(startDate) && throwError(new Error("End date cannot be before start date"));
 
-const provider = getDefaultProvider(chainId, {
-  etherscan: etherscanApiKey,
-  alchemy: alchemyApiKey,
-  infura: infuraApiKey,
-});
+const provider = jsonRpcUrl
+  ? getDefaultProvider(jsonRpcUrl)
+  : getDefaultProvider(chainId, {
+      etherscan: etherscanApiKey,
+      alchemy: alchemyApiKey,
+      infura: infuraApiKey,
+    });
 
 (async () => {
   try {
diff --git a/snapshots/package.json b/snapshots/package.json
@@ -24,7 +24,9 @@
     "ramda": "^0.27.1",
     "yargs": "^16.2.0"
   },
-  "devDependencies": {},
+  "devDependencies": {
+    "eslint-plugin-json": "^3.1.0"
+  },
   "volta": {
     "node": "14.16.0"
   }
diff --git a/snapshots/src/assets/xKlerosLiquid.json b/snapshots/src/assets/xKlerosLiquid.json
diff --git a/snapshots/src/create-snapshot-from-block-limits.js b/snapshots/src/create-snapshot-from-block-limits.js
@@ -1,7 +1,6 @@
 import { MerkleTree } from "@kleros/merkle-tree";
 import dayjs from "dayjs";
 import utc from "dayjs/plugin/utc.js";
-// import deepMerge from "deepmerge";
 import { BigNumber, Contract } from "ethers";
 import { readFile } from "fs/promises";
 import {
@@ -32,6 +31,13 @@ import { createGetEvents } from "./helpers/events.js";
 
 dayjs.extend(utc);
 
+const chainIdToContract = {
+  1: "./assets/KlerosLiquid.json",
+  42: "./assets/KlerosLiquid.json",
+  100: "./assets/xKlerosLiquid.json",
+  77: "./assets/xKlerosLiquid.json",
+};
+
 export async function createSnapshotCreator({
   provider,
   klerosLiquidAddress,
@@ -41,7 +47,8 @@ export async function createSnapshotCreator({
 }) {
   const { getEvents } = createGetEvents(createGetBlockWithTimestamp(provider));
 
-  const KlerosLiquid = JSON.parse(await readFile(new URL("./assets/KlerosLiquid.json", import.meta.url)));
+  const { chainId } = await provider.getNetwork();
+  const KlerosLiquid = JSON.parse(await readFile(new URL(chainIdToContract[chainId], import.meta.url)));
   const klerosLiquid = new Contract(klerosLiquidAddress, KlerosLiquid.abi, provider);
 
   async function createSnapshot({ fromBlock = 0, toBlock, startDate, endDate } = {}) {
@@ -206,7 +213,7 @@ export async function createSnapshotCreator({
  *            Start Block                                                        End Block
  *
  *
- * 2. There are no events within the interval, but there it:
+ * 2. There are no events within the interval, but there is at least one before it:
  *
  *    A
  *    |            .                                                               .
diff --git a/snapshots/src/create-snapshot.js b/snapshots/src/create-snapshot.js
@@ -32,6 +32,13 @@ import { createGetEvents } from "./helpers/events.js";
 
 dayjs.extend(utc);
 
+const chainIdToContract = {
+  1: "./assets/KlerosLiquid.json",
+  42: "./assets/KlerosLiquid.json",
+  100: "./assets/xKlerosLiquid.json",
+  77: "./assets/xKlerosLiquid.json",
+};
+
 export async function createSnapshotCreator({
   provider,
   klerosLiquidAddress,
@@ -41,7 +48,8 @@ export async function createSnapshotCreator({
 }) {
   const { getEventsWithTimestamp } = createGetEvents(createGetBlockWithTimestamp(provider));
 
-  const KlerosLiquid = JSON.parse(await readFile(new URL("./assets/KlerosLiquid.json", import.meta.url)));
+  const { chainId } = await provider.getNetwork();
+  const KlerosLiquid = JSON.parse(await readFile(new URL(chainIdToContract[chainId], import.meta.url)));
   const klerosLiquid = new Contract(klerosLiquidAddress, KlerosLiquid.abi, provider);
 
   async function createSnapshot({ fromBlock = 0, toBlock, startDate, endDate } = {}) {
diff --git a/snapshots/src/helpers/events.js b/snapshots/src/helpers/events.js
@@ -84,7 +84,9 @@ export function createGetEvents(getBlock) {
 
 async function fetchEvents(contract, filter, fromBlock, toBlock) {
   debug("Fetching events from block:", fromBlock, "to block:", toBlock);
-  return await contract.queryFilter(filter, fromBlock, toBlock);
+  const events = await contract.queryFilter(filter, fromBlock, toBlock);
+  debug("Got", events.length, "events from block:", fromBlock, "to block:", toBlock);
+  return events;
 }
 
 function splitBlockInterval(fromBlock, toBlock, batchSize) {
diff --git a/snapshots/src/store-snapshot.js b/snapshots/src/store-snapshot.js
@@ -8,6 +8,8 @@ const FILE_NAME_TEMPLATE = "{{prefix}}snapshot-{{period}}.json";
 const prefixByChainId = {
   42: "kovan-",
   1: "",
+  100: "xdai-",
+  77: "sokol-",
 };
 
 export async function storeOnIpfs({ chainId, period, content }) {
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -34,5 +34,14 @@`
`34`	`34`	`"commonjs": true`
`35`	`35`	`}`
`36`	`36`	`]`
`37`		`- }`
	`37`	`+ },`
	`38`	`+ "overrides": [`
	`39`	`+ {`
	`40`	`+ "files": "*.json",`
	`41`	`+ "extends": "plugin:json/recommended",`
	`42`	`+ "plugins": [`
	`43`	`+ "json"`
	`44`	`+ ]`
	`45`	`+ }`
	`46`	`+ ]`
`38`	`47`	`}`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+#!/bin/bash`
	`2`	`+# npx hardhat flatten src/MerkleRedeem.sol 2> /dev/null \| awk '/SPDX-License-Identifier/&&c++>0 {next} 1' \| awk '/pragma experimental ABIEncoderV2;/&&c++>0 {next} 1'`
	`3`	`+npx hardhat flatten src/MerkleRedeem.sol 2> /dev/null`