add dependencies

Author: massun-onibakuchi

.env.example

@@ -0,0 +1,6 @@
+ALCHEMY_API_KEY=
+MNEMONIC=
+FORK=false
+TENDERLY_ACCESS_TOKEN=
+ETHERSCAN_API_KEY=
+BLOCK_NUMBER=

.eslintignore

@@ -0,0 +1,5 @@
+contracts/
+typechain/
+cache/
+artifacts/
+node_modules/

.eslintrc.json

@@ -0,0 +1,20 @@
+{
+    "env": {
+        "node": true,
+        "es6": true,
+        "mocha": true
+    },
+    "extends": ["eslint:recommended"],
+    "plugins": [],
+    "globals": {
+        "Atomics": "readonly",
+        "SharedArrayBuffer": "readonly"
+    },
+    "parserOptions": {
+        "ecmaVersion": 2019
+    },
+    "root": true,
+    "rules": {
+        "no-unused-vars": "off"
+    }
+}

.gitignore

@@ -0,0 +1,28 @@
+node_modules/
+
+# env variables
+.env
+
+# log
+*.log
+
+# hardhat
+artifacts/
+cache/
+typechain/
+typechain-types/
+deployments/
+
+flattened/
+
+# hardhat-dependency-compiler
+hardhat-dependency-compiler/
+
+# macOS
+.DS_Store
+
+# Coverage
+coverage
+coverage.json
+
+hints.md

.mocharc.js

@@ -0,0 +1,16 @@
+"use strict"
+process.env.TS_NODE_FILES = true
+module.exports = {
+    "allow-uncaught": true,
+    diff: true,
+    extension: ["ts"],
+    recursive: true,
+    reporter: "spec",
+    require: ["ts-node/register", "hardhat/register"],
+    slow: 300,
+    spec: "test/**/*.test.**",
+    timeout: 20000,
+    ui: "bdd",
+    watch: false,
+    "watch-files": ["contracts/**/*.sol", "test/**/*.ts"],
+}

.prettierignore

@@ -0,0 +1,4 @@
+typechain/
+cache/
+artifacts/
+typechain-types/

.prettierrc

@@ -0,0 +1,23 @@
+{
+    "endOfLine": "auto",
+    "bracketSpacing": true,
+    "overrides": [
+        {
+            "files": "*.sol",
+            "options": {
+                "tabWidth": 4,
+                "singleQuote": false,
+                "explicitTypes": "always"
+            }
+        },
+        {
+            "files": "*.{js,ts}",
+            "options": {
+                "arrowParens": "avoid",
+                "tabWidth": 2,
+                "singleQuote": true,
+                "semi": false
+            }
+        }
+    ]
+}

README.md

@@ -0,0 +1,45 @@
+# Smart Contracts Vulns Hacking
+
+## Getting Started
+
+### Setup
+
+`yarn`
+
+To run testing on the forking main net, set the APIKEY and mnemonic.
+you need access to an archive node like the free ones from [Alchemy](https://alchemyapi.io/).
+```
+ALCHEMY_API_KEY=
+MNEMONIC=
+BLOCK_NUMBER=
+FORK=false
+```
+
+### Compiling
+
+`yarn compile`
+
+### Replaying hack
+
+The hacks are implemented as hardhat tests and can therefore be run as:
+
+`yarn hardhat test test/<name>.ts`
+
+### Debugging transactions with tenderly
+
+Set up `tenderly.yaml` in the repo root and follow [this article](http://blog.tenderly.co/level-up-your-smart-contract-productivity-using-hardhat-and-tenderly/).
+
+TLDR:
+
+```bash
+# run this in second terminal
+npx hardhat node
+# run test against local network
+npx hardhat test test/foo.js --network local
+# you want an actual tx id which means the tx may not fail in eth_estimateGas already
+# therefore hardcode some gas values
+# {value: ethers.utils.parseEther(`100`), gasLimit: `15000000`, gasPrice: ethers.utils.parseUnits(`200`, 9) }
+# the (failed) tx hash appears on the CLI after "eth_sendTransaction"
+# --force is required to skip gas estimation check in tenderly
+tenderly export <txHash> --force
+```

hardhat.config.ts

@@ -0,0 +1,72 @@
+import "dotenv/config"
+import { HardhatUserConfig } from "hardhat/config"
+import "@typechain/hardhat"
+import "@nomiclabs/hardhat-waffle"
+import "@nomiclabs/hardhat-ethers"
+
+const ALCHEMY_API_KEY = process.env.ALCHEMY_API_KEY
+const ETHERSCAN_API_KEY = process.env.ETHERSCAN_API_KEY
+const BLOCK_NUMBER = process.env.BLOCK_NUMBER
+const MNEMONIC = process.env.MNEMONIC
+const FORK = process.env.FORK
+
+if (FORK && !ALCHEMY_API_KEY) throw new Error("ALCHEMY_API_KEY_NOT_FOUND")
+
+/**
+ * @type import('hardhat/config').HardhatUserConfig
+ */
+const config: HardhatUserConfig = {
+    defaultNetwork: "hardhat",
+    networks: {
+        local: {
+            url: "http://127.0.0.1:8545",
+        },
+        hardhat: {
+            forking:
+            {
+                enabled: FORK === "true",
+                url: `https://eth-mainnet.alchemyapi.io/v2/${ALCHEMY_API_KEY}`,
+                blockNumber: BLOCK_NUMBER ? Number(BLOCK_NUMBER) : undefined
+            }
+        },
+        mainnet: {
+            url: `https://eth-mainnet.alchemyapi.io/v2/${ALCHEMY_API_KEY}`,
+            chainId: 1,
+        },
+    },
+    solidity: {
+        compilers: [
+            {
+                version: "0.8.10",
+                settings: {
+                    optimizer: {
+                        enabled: true,
+                        runs: 200,
+                    },
+                    // outputSelection: {
+                    //     '*': {
+                    //         '*': ['storageLayout']
+                    //     }
+                    // }
+                },
+            },
+            {
+                version: "0.7.6",
+                settings: {
+                    optimizer: {
+                        enabled: true,
+                        runs: 200,
+                    }
+                },
+            },
+        ],
+    },
+    paths: {
+        sources: "./contracts",
+        tests: "./test",
+        cache: "./cache",
+        artifacts: "./artifacts",
+    },
+}
+
+export default config

package.json

@@ -0,0 +1,41 @@
+{
+    "name": "sol-challenge",
+    "version": "1.0.0",
+    "main": "index.js",
+    "author": "massun-onibakuchi",
+    "license": "MIT",
+    "dependencies": {
+        "@openzeppelin/contracts": "^4.6.0",
+        "hardhat": "^2.8.0"
+    },
+    "devDependencies": {
+        "@nomiclabs/hardhat-ethers": "^2.0.3",
+        "@nomiclabs/hardhat-waffle": "^2.0.1",
+        "@typechain/ethers-v5": "^8.0.5",
+        "@typechain/hardhat": "^3.1.0",
+        "@types/mocha": "^9.0.0",
+        "@types/node": "^17.0.7",
+        "chai": "^4.3.4",
+        "dotenv": "^10.0.0",
+        "eslint": "^8.6.0",
+        "ethereum-waffle": "^3.4.0",
+        "ethers": "^5.5.2",
+        "prettier": "^2.5.1",
+        "prettier-plugin-solidity": "^1.0.0-beta.19",
+        "ts-node": "^10.4.0",
+        "typechain": "^6.1.0",
+        "typescript": "^4.5.4"
+    },
+    "scripts": {
+        "compile": "hardhat compile",
+        "console": "hardhat console",
+        "test": "yarn hardhat test",
+        "typechain": "hardhat typechain",
+        "chain": "hardhat node",
+        "deploy": "hardhat deploy",
+        "lint": "prettier --list-different 'contracts/**/*.sol' && prettier -c 'test/**/*.ts'",
+        "format:sol": "prettier --write 'contracts/**/*.sol'",
+        "format:ts": "prettier --write 'test/**/*.ts'",
+        "format": "yarn format:sol && yarn format:ts"
+    }
+}

tsconfig.json

@@ -0,0 +1,25 @@
+{
+    "compilerOptions": {
+        "target": "ES2018",
+        "module": "commonjs",
+        "lib": ["es2018"],
+        "sourceMap": false,
+        "removeComments": false,
+        "downlevelIteration": true,
+        "strict": true,
+        "noImplicitAny": false,
+        "strictNullChecks": false,
+        "strictFunctionTypes": false,
+        "strictBindCallApply": false,
+        "strictPropertyInitialization": false,
+        "noImplicitThis": false,
+        "moduleResolution": "node",
+        "esModuleInterop": true,
+        "resolveJsonModule": true,
+        "skipLibCheck": true,
+        "forceConsistentCasingInFileNames": true
+    },
+    "include": ["./hardhat.config.ts", "./scripts", "./deploy", "./test"],
+    "exclude": [],
+    "files": ["./hardhat.config.ts"]
+}