feat: challenge completed

.github/workflows/foundry.yml

@@ -0,0 +1,30 @@
+name: foundry actions
+
+on: [push, pull_request]
+
+env:
+    FOUNDRY_PROFILE: ci
+
+jobs:
+    foundry:
+        name: Foundry project
+        runs-on: ubuntu-latest
+        steps:
+            - uses: actions/checkout@v3
+              with:
+                  submodules: recursive
+
+            - name: Install Foundry
+              uses: foundry-rs/foundry-toolchain@v1
+              with:
+                  version: nightly
+
+            - name: Run Forge build
+              run: |
+                  forge --version
+                  forge build --sizes
+              id: build
+
+            - name: Run Forge tests
+              run: forge test -vvv
+              id: forge-test

.github/workflows/prettier_n_linters.yml

@@ -0,0 +1,39 @@
+name: prettier & linters
+
+on: [push, pull_request]
+
+jobs:
+    prettier:
+        name: Prettier check
+        runs-on: ubuntu-latest
+        steps:
+            - uses: actions/checkout@v2
+            - uses: actionsx/prettier@v2
+              with:
+                  args: --check .
+
+    commitlint:
+        name: Commit-lint check
+        runs-on: ubuntu-latest
+        steps:
+            - uses: actions/checkout@v3
+              with:
+                  fetch-depth: 5
+            - uses: wagoid/commitlint-github-action@v5
+              with:
+                  failOnWarnings: true
+
+    solhint:
+        name: Solhint check
+        runs-on: ubuntu-latest
+        steps:
+            - uses: actions/checkout@v2
+            - name: Setup Node 16
+              uses: actions/setup-node@v3
+              with:
+                  node-version: '16.x'
+                  cache: 'npm'
+            - name: Install Node dependencies
+              run: rm -rf node_modules && yarn install --immutable --immutable-cache --check-cache # equivalent of `npm ci`
+            - name: Solhint check
+              run: npx solhint src/*.sol

.gitignore

@@ -0,0 +1,18 @@
+# Foundry
+cache/
+out/
+
+# JS
+node_modules/
+
+#Hardhat files
+cache_hardhat/
+artifacts/
+
+#Hardhat plugin files
+typechain-types/
+
+.DS_Store
+
+.bash_history
+.env

.gitmodules

@@ -0,0 +1,9 @@
+[submodule "project/lib/forge-std"]
+	path = project/lib/forge-std
+	url = https://github.com/foundry-rs/forge-std
+[submodule "project/lib/solmate"]
+	path = project/lib/solmate
+	url = https://github.com/rari-capital/solmate
+[submodule "project/lib/openzeppelin-contracts"]
+	path = project/lib/openzeppelin-contracts
+	url = https://github.com/Openzeppelin/openzeppelin-contracts

.husky/commit-msg

@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+npx --no -- commitlint --edit "$1"

.husky/pre-commit

@@ -0,0 +1,5 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+npx solhint src/*.sol test/*.sol --fix
+npx prettier --check .

.prettierignore

@@ -0,0 +1,19 @@
+# Foundry
+cache/
+out/
+
+#JS
+node_modules
+.next
+build
+coverage
+
+# Import
+lib
+
+#Hardhat files
+cache_hardhat/
+artifacts/
+
+#Hardhat plugin files
+typechain-types/

.prettierrc

@@ -0,0 +1,17 @@
+{
+    "semi": true,
+    "tabWidth": 4,
+    "printWidth": 79,
+    "singleQuote": true,
+    "trailingComma": "es5",
+    "overrides": [
+        {
+            "files": "*.sol",
+            "options": {
+                "useTabs": false,
+                "singleQuote": false,
+                "explicitTypes": "always"
+            }
+        }
+    ]
+}

.solhint.json

@@ -0,0 +1,20 @@
+{
+    "extends": "solhint:recommended",
+    "plugins": ["prettier"],
+    "rules": {
+        "code-complexity": ["error", 8],
+        "compiler-version": ["error", ">=0.8.0"],
+        "constructor-syntax": "error",
+        "func-visibility": ["error", { "ignoreConstructors": true }],
+        "state-visibility": "error",
+        "max-line-length": ["error", 120],
+        "not-rely-on-time": "off",
+        "prettier/prettier": [
+            "error",
+            {
+                "endOfLine": "auto"
+            }
+        ],
+        "reason-string": ["warn", { "maxLength": 64 }]
+    }
+}

.solhintignore

@@ -0,0 +1 @@
+# Add files to exclude from solhint

README.md

@@ -10,9 +10,9 @@ ETHPool provides a service where people can deposit ETH and they will receive we
 
 #### Requirements
 
-- Only the team can deposit rewards.
-- Deposited rewards go to the pool of users, not to individual users.
-- Users should be able to withdraw their deposits along with their share of rewards considering the time when they deposited.
+-   Only the team can deposit rewards.
+-   Deposited rewards go to the pool of users, not to individual users.
+-   Users should be able to withdraw their deposits along with their share of rewards considering the time when they deposited.
 
 Example:
 
@@ -32,9 +32,9 @@ You can use any development tools you prefer: Hardhat, Truffle, Brownie, Solidit
 
 Useful resources:
 
-- Solidity Docs: https://docs.soliditylang.org/en/v0.8.4
-- Educational Resource: https://github.com/austintgriffith/scaffold-eth
-- Project Starter: https://github.com/abarmat/solidity-starter
+-   Solidity Docs: https://docs.soliditylang.org/en/v0.8.4
+-   Educational Resource: https://github.com/austintgriffith/scaffold-eth
+-   Project Starter: https://github.com/abarmat/solidity-starter
 
 ### 2) Write tests
 
@@ -46,7 +46,7 @@ Deploy the contract to any Ethereum testnet of your preference. Keep record of t
 
 Bonus:
 
-- Verify the contract in Etherscan
+-   Verify the contract in Etherscan
 
 ### 4) Interact with the contract
 
@@ -55,8 +55,15 @@ Create a script (or a Hardhat task) to query the total amount of ETH held in the
 _You can use any library you prefer: Ethers.js, Web3.js, Web3.py, eth-brownie_
 
 ### 5) Contact
-- Using this repository, work on the challenge by creating a branch with your name (example: name-surname).
 
-- On your project, create a repository called 'project'. All files that you create must be inside this folder.
+-   Using this repository, work on the challenge by creating a branch with your name (example: name-surname).
 
-- When you're done with your challenge, open a Merge Request with your changes.
+-   On your project, create a repository called 'project'. All files that you create must be inside this folder.
+
+-   When you're done with your challenge, open a Merge Request with your changes.
+
+## Results
+
+-   First version deployed on Goerli and verified [here](https://goerli.etherscan.io/address/0xF9C1b8AC4873117ABDB5e18d25B3f66CE8282397#code)
+-   Second and final version on Goerli (https://goerli.etherscan.io/address/0x7aC2a52959D780d6ADBE970f3e0B36F1642Ca470#code)
+-   2 JS scripts in `project/scripts`: `deploy`, `verify` and `ethBalanceInPool`

commitlint.config.js

@@ -0,0 +1 @@
+module.exports = { extends: ['@commitlint/config-conventional'] };

package.json

@@ -0,0 +1,43 @@
+{
+    "name": "hardhat-foundry-template",
+    "version": "1.0.0",
+    "description": "The harmony between Foundry and Hardhat.",
+    "directories": {
+        "lib": "lib",
+        "test": "test"
+    },
+    "scripts": {
+        "test": "hardhat test",
+        "prepare": "husky install"
+    },
+    "author": "Devan Non <devanon@chainstride.capital>",
+    "license": "Apache-2.0",
+    "devDependencies": {
+        "@commitlint/cli": "^17.0.2",
+        "@commitlint/config-conventional": "^17.0.2",
+        "@nomicfoundation/hardhat-foundry": "^1.0.0",
+        "@nomiclabs/hardhat-ethers": "^2.0.6",
+        "@nomiclabs/hardhat-etherscan": "^3.1.3",
+        "@nomiclabs/hardhat-waffle": "^2.0.3",
+        "@typechain/ethers-v5": "^10.0.0",
+        "@typechain/hardhat": "^6.0.0",
+        "@types/chai": "^4.3.0",
+        "@types/mocha": "^9.1.0",
+        "@types/node": "^17.0.35",
+        "chai": "^4.3.6",
+        "dotenv": "^16.0.3",
+        "ethereum-waffle": "^3.2.0",
+        "ethers": "^5.6.6",
+        "hardhat": "^2.9.5",
+        "hardhat-preprocessor": "^0.1.4",
+        "husky": "^8.0.0",
+        "prettier": "^2.6.2",
+        "prettier-plugin-solidity": "1.1.0",
+        "solhint": "3.3.7",
+        "solhint-plugin-prettier": "^0.0.5",
+        "solidity-coverage": "^0.8.2",
+        "ts-node": "^10.7.0",
+        "typechain": "^8.0.0",
+        "typescript": "^4.6.4"
+    }
+}

project/.env.example

@@ -0,0 +1,3 @@
+RPC_URL="see https://chainlist.org"
+SEED="word1 word2 ... word12"
+EXPLORER_KEY=

project/.gitignore

@@ -0,0 +1,18 @@
+# Foundry
+cache/
+out/
+
+# JS
+node_modules/
+
+#Hardhat files
+cache_hardhat/
+artifacts/
+
+#Hardhat plugin files
+typechain-types/
+
+.DS_Store
+
+.bash_history
+.env

project/.prettierignore

@@ -0,0 +1,4 @@
+# Foundry
+cache/
+out/
+lib/

project/.vscode/settings.json

@@ -0,0 +1,21 @@
+{
+    "editor.defaultFormatter": "esbenp.prettier-vscode",
+    "editor.formatOnSave": true,
+    "editor.formatOnPaste": true,
+    "emmet.excludeLanguages": ["markdown"],
+    "workbench.colorTheme": "Darcula - WebStorm Edition",
+    "files.autoSave": "afterDelay",
+    "workbench.startupEditor": "newUntitledFile",
+    "todo-tree.tree.showScanModeButton": false,
+    "javascript.updateImportsOnFileMove.enabled": "always",
+    "workbench.colorCustomizations": {},
+    "todo-tree.general.tags": ["BUG", "HACK", "FIXME", "TODO", "TEST"],
+    "git.autofetch": true,
+    "window.menuBarVisibility": "compact",
+    "terminal.integrated.defaultProfile.windows": "Command Prompt",
+    "workbench.editor.untitled.hint": "hidden",
+    "diffEditor.ignoreTrimWhitespace": false,
+    "[terraform]": {
+        "editor.defaultFormatter": "hashicorp.terraform"
+    }
+}