Initial commit

Spencer Graham · Spencer Graham · commit f9a545cc232a · 2020-07-31T13:09:00.000-05:00
diff --git a/.commitlintrc.js b/.commitlintrc.js
@@ -0,0 +1,3 @@
+module.exports = {
+  extends: ["@commitlint/config-conventional"],
+};
diff --git a/.editorconfig b/.editorconfig
@@ -0,0 +1,16 @@
+# EditorConfig  http://EditorConfig.org
+
+# top-most EditorConfig file
+root = true
+
+# All files
+[*]
+charset = utf-8
+end_of_line = lf
+indent_size = 2
+indent_style = space
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.sol]
+indent_size = 4
diff --git a/.env.example b/.env.example
@@ -0,0 +1,3 @@
+ETHERSCAN_API_KEY=aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
+INFURA_API_KEY=zzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz
+MNEMONIC=here is where your twelve words mnemonic should be put my friend
diff --git a/.eslintignore b/.eslintignore
@@ -0,0 +1,13 @@
+# folders
+artifacts/
+build/
+cache/
+coverage/
+dist/
+lib/
+node_modules/
+typechain/
+
+# files
+.solcover.js
+coverage.json
diff --git a/.eslintrc.yaml b/.eslintrc.yaml
@@ -0,0 +1,21 @@
+extends:
+  - eslint:recommended
+  - plugin:@typescript-eslint/eslint-recommended
+  - plugin:@typescript-eslint/recommended
+  - prettier/@typescript-eslint
+parser: "@typescript-eslint/parser"
+parserOptions:
+  project: tsconfig.json
+plugins:
+  - "@typescript-eslint"
+root: true
+rules:
+  "@typescript-eslint/no-floating-promises":
+    - error
+    - ignoreIIFE: true
+      ignoreVoid: true
+  "@typescript-eslint/no-inferrable-types": 'off'
+  "@typescript-eslint/no-unused-vars":
+    - error
+    - argsIgnorePattern: _
+      varsIgnorePattern: _
diff --git a/.gitattributes b/.gitattributes
@@ -0,0 +1 @@
+*.sol linguist-language=Solidity
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,21 @@
+# folders
+.coverage_artifacts/
+.coverage_cache/
+.coverage_contracts/
+artifacts/
+build/
+cache/
+coverage/
+dist/
+lib/
+node_modules/
+typechain/
+
+# files
+*.env
+*.log
+*.tsbuildinfo
+coverage.json
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
diff --git a/.huskyrc b/.huskyrc
@@ -0,0 +1,5 @@
+{
+  "hooks": {
+    "commit-msg": "commitlint -E HUSKY_GIT_PARAMS"
+  }
+}
diff --git a/.mocharc.json b/.mocharc.json
@@ -0,0 +1,7 @@
+{
+  "delay": true,
+  "extension": ["ts"],
+  "recursive": "test",
+  "require": ["@nomiclabs/buidler/register"],
+  "timeout": 20000
+}
diff --git a/.prettierignore b/.prettierignore
@@ -0,0 +1,12 @@
+# folders
+artifacts/
+build/
+cache/
+coverage/
+dist/
+lib/
+node_modules/
+typechain/
+
+# files
+coverage.json
diff --git a/.prettierrc b/.prettierrc
@@ -0,0 +1,16 @@
+{
+  "arrowParens": "avoid",
+  "bracketSpacing": true,
+  "printWidth": 120,
+  "singleQuote": false,
+  "tabWidth": 2,
+  "trailingComma": "all",
+  "overrides": [
+    {
+      "files": "*.sol",
+      "options": {
+        "tabWidth": 4
+      }
+    }
+  ]
+}
diff --git a/.solcover.js b/.solcover.js
@@ -0,0 +1,15 @@
+const shell = require("shelljs");
+
+module.exports = {
+  istanbulReporter: ["html"],
+  mocha: {
+    delay: true,
+  },
+  onCompileComplete: async function (_config) {
+    await run("typechain");
+  },
+  onIstanbulComplete: async function (_config) {
+    shell.rm("-rf", "./typechain");
+  },
+  skipFiles: ["mocks", "test"],
+};
diff --git a/.solhint.json b/.solhint.json
@@ -0,0 +1,12 @@
+{
+  "extends": "solhint:recommended",
+  "plugins": ["prettier"],
+  "rules": {
+    "code-complexity": ["error", 7],
+    "compiler-version": ["error", "^0.6.10"],
+    "constructor-syntax": "error",
+    "max-line-length": ["error", 120],
+    "not-rely-on-time": "off",
+    "prettier/prettier": "error"
+  }
+}
diff --git a/.solhintignore b/.solhintignore
@@ -0,0 +1,5 @@
+# folders
+.yarn/
+build/
+dist/
+node_modules/
diff --git a/@types/augmentations.d.ts b/@types/augmentations.d.ts
@@ -0,0 +1,23 @@
+import { Greeter } from "../typechain/Greeter";
+
+export interface TypechainConfig {
+  outDir?: string;
+  target?: "ethers-v4" | "ethers-v5" | "truffle-v4" | "truffle-v5" | "web3-v1";
+}
+
+declare module "@nomiclabs/buidler/types" {
+  interface BuidlerConfig {
+    typechain?: TypechainConfig;
+  }
+
+  interface ProjectPaths {
+    coverage: string;
+    coverageJson: string;
+    typechain: string;
+  }
+}
+declare module "mocha" {
+  export interface Context {
+    greeter: Greeter;
+  }
+}
diff --git a/@types/buidler-env.d.ts b/@types/buidler-env.d.ts
@@ -0,0 +1,3 @@
+/// <reference types="@nomiclabs/buidler/types" />
+/// <reference types="@nomiclabs/buidler-ethers/src/type-extensions" />
+/// <reference types="@nomiclabs/buidler-waffle/src/type-extensions" />
diff --git a/README.md b/README.md
@@ -0,0 +1,3 @@
+## Solidity Template
+
+To be used when building a new solidity project from scratch.
diff --git a/buidler.config.ts b/buidler.config.ts
@@ -0,0 +1,93 @@
+import { config as dotenvConfig } from "dotenv";
+import { resolve } from "path";
+dotenvConfig({ path: resolve(__dirname, "./.env") });
+
+import { BuidlerConfig, usePlugin } from "@nomiclabs/buidler/config";
+import { HDAccountsConfig } from "@nomiclabs/buidler/types";
+import "./tasks/accounts";
+import "./tasks/clean";
+import "./tasks/typechain";
+
+usePlugin("@nomiclabs/buidler-waffle");
+usePlugin("solidity-coverage");
+
+interface HDAccountsConfigExtended extends HDAccountsConfig {
+  url: string;
+}
+
+/**
+ * @dev You must have a `.env` file. Follow the example in `.env.example`.
+ * @param {string} network The name of the testnet
+ */
+function createHDAccountConfig(network: string): HDAccountsConfigExtended {
+  if (!process.env.MNEMONIC) {
+    console.log("Please set your MNEMONIC in a .env file");
+    process.exit(1);
+  }
+
+  if (!process.env.INFURA_API_KEY) {
+    console.log("Please set your INFURA_API_KEY");
+    process.exit(1);
+  }
+
+  return {
+    initialIndex: 0,
+    mnemonic: process.env.MNEMONIC,
+    path: "m/44'/60'/0'/0",
+    url: `https://${network}.infura.io/v3/${process.env.INFURA_API_KEY}`,
+  };
+}
+
+const config: BuidlerConfig = {
+  defaultNetwork: "buidlerevm",
+  mocha: {
+    delay: true,
+  },
+  networks: {
+    buidlerevm: {
+      chainId: 31337,
+    },
+    coverage: {
+      url: "http://127.0.0.1:8555",
+    },
+    goerli: {
+      ...createHDAccountConfig("goerli"),
+      chainId: 5,
+    },
+    kovan: {
+      ...createHDAccountConfig("kovan"),
+      chainId: 42,
+    },
+    rinkeby: {
+      ...createHDAccountConfig("rinkeby"),
+      chainId: 4,
+    },
+    ropsten: {
+      ...createHDAccountConfig("ropsten"),
+      chainId: 3,
+    },
+  },
+  paths: {
+    artifacts: "./artifacts",
+    cache: "./cache",
+    coverage: "./coverage",
+    coverageJson: "./coverage.json",
+    root: "./",
+    sources: "./contracts",
+    tests: "./test",
+  },
+  solc: {
+    /* https://buidler.dev/buidler-evm/#solidity-optimizer-support */
+    optimizer: {
+      enabled: false,
+      runs: 200,
+    },
+    version: "0.6.10",
+  },
+  typechain: {
+    outDir: "typechain",
+    target: "ethers-v5",
+  },
+};
+
+export default config;
diff --git a/contracts/Greeter.sol b/contracts/Greeter.sol
@@ -0,0 +1,22 @@
+/* SPDX-License-Identifier: MIT */
+pragma solidity ^0.6.10;
+
+import "@nomiclabs/buidler/console.sol";
+
+contract Greeter {
+    string public greeting;
+
+    constructor(string memory _greeting) public {
+        console.log("Deploying a Greeter with greeting:", _greeting);
+        greeting = _greeting;
+    }
+
+    function greet() public view returns (string memory) {
+        return greeting;
+    }
+
+    function setGreeting(string memory _greeting) public {
+        console.log("Changing greeting from '%s' to '%s'", greeting, _greeting);
+        greeting = _greeting;
+    }
+}
diff --git a/package.json b/package.json
@@ -0,0 +1,83 @@
+{
+  "name": "@paulrberg/solidity-template",
+  "description": "To be used when building a new solidity project from scratch",
+  "version": "1.0.0",
+  "author": {
+    "name": "Paul Razvan Berg",
+    "url": "https://paulrberg.com"
+  },
+  "bugs": {
+    "url": "https://github.com/paulrberg/solidity-template/issues"
+  },
+  "devDependencies": {
+    "@commitlint/cli": "^9.0.1",
+    "@commitlint/config-conventional": "^9.0.1",
+    "@ethersproject/abstract-signer": "^5.0.1",
+    "@ethersproject/bignumber": "^5.0.3",
+    "@ethersproject/wallet": "^5.0.1",
+    "@nomiclabs/buidler": "^1.3.8",
+    "@nomiclabs/buidler-ethers": "^2.0.0",
+    "@nomiclabs/buidler-waffle": "^2.0.0",
+    "@typechain/ethers-v5": "^0.0.2",
+    "@types/chai": "^4.2.11",
+    "@types/fs-extra": "^9.0.1",
+    "@types/mocha": "^7.0.2",
+    "@types/node": "^14.0.14",
+    "@typescript-eslint/eslint-plugin": "^3.6.0",
+    "@typescript-eslint/parser": "^3.6.0",
+    "chai": "^4.2.0",
+    "commitizen": "^4.1.2",
+    "cz-conventional-changelog": "^3.2.0",
+    "dotenv": "^8.2.0",
+    "eslint": "^7.4.0",
+    "eslint-config-prettier": "^6.11.0",
+    "ethereum-waffle": "^3.0.1",
+    "ethers": "^5.0.4",
+    "fs-extra": "^9.0.1",
+    "husky": "^4.2.5",
+    "mocha": "^8.0.1",
+    "prettier": "^2.0.5",
+    "prettier-plugin-solidity": "^1.0.0-alpha.54",
+    "shelljs": "^0.8.4",
+    "shx": "^0.3.2",
+    "solc": "0.6.10",
+    "solhint": "^3.0.0",
+    "solhint-plugin-prettier": "^0.0.4",
+    "solidity-coverage": "^0.7.9",
+    "ts-generator": "^0.0.8",
+    "ts-node": "^8.10.2",
+    "typechain": "^2.0.0",
+    "typescript": "^3.9.6"
+  },
+  "files": [
+    "/contracts"
+  ],
+  "homepage": "https://github.com/paulrberg/solidity-template#readme",
+  "keywords": [
+    "blockchain",
+    "ethereum",
+    "smart-contracts",
+    "solidity"
+  ],
+  "license": "LGPL-3.0-or-later",
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/paulrberg/solidity-template"
+  },
+  "scripts": {
+    "build": "yarn run compile && yarn run typechain",
+    "clean": "buidler clean",
+    "commit": "git-cz",
+    "compile": "buidler compile",
+    "coverage": "buidler coverage --solcoverjs ./.solcover.js --network coverage --temp artifacts --testfiles \"./test/**/*.ts\"",
+    "lint:sol": "solhint --config ./.solhint.json --max-warnings 0 \"contracts/**/*.sol\"",
+    "lint:ts": "eslint --config ./.eslintrc.yaml --ignore-path ./.eslintignore --ext .js,.ts .",
+    "prettier": "prettier --config .prettierrc --write \"**/*.{js,json,md,sol,ts}\"",
+    "prettier:list-different": "prettier --config .prettierrc --list-different \"**/*.{js,json,md,sol,ts}\"",
+    "test": "buidler test",
+    "typechain": "buidler typechain"
+  }
+}
diff --git a/scripts/deploy.ts b/scripts/deploy.ts
diff --git a/tasks/accounts.ts b/tasks/accounts.ts
diff --git a/tasks/clean.ts b/tasks/clean.ts
diff --git a/tasks/task-names.ts b/tasks/task-names.ts
diff --git a/tasks/typechain.ts b/tasks/typechain.ts
diff --git a/test/Greeter.behavior.ts b/test/Greeter.behavior.ts
diff --git a/test/Greeter.ts b/test/Greeter.ts
diff --git a/tsconfig.json b/tsconfig.json
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+module.exports = {`
	`2`	`+ extends: ["@commitlint/config-conventional"],`
	`3`	`+};`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+ETHERSCAN_API_KEY=aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa`
	`2`	`+INFURA_API_KEY=zzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz`
	`3`	`+MNEMONIC=here is where your twelve words mnemonic should be put my friend`
-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +{
 +  "hooks": {
 +    "commit-msg": "commitlint -E HUSKY_GIT_PARAMS"
 +  }
 +}