├── .gitignore
├── .env.example
├── tsconfig.json
├── test
    ├── unit
    │   ├── Lending
    │   │   └── LendingShouldDeposit.spec.ts
    │   └── index.ts
    └── shared
    │   ├── types.ts
    │   ├── mocks.ts
    │   └── fixtures.ts
├── package.json
├── LICENSE
├── hardhat.config.ts
├── scripts
    └── deploy.ts
├── contracts
    └── Lending.sol
├── README.md
└── abis
    └── erc20.abi.json


/.gitignore:
--------------------------------------------------------------------------------
 1 | node_modules
 2 | .env
 3 | coverage
 4 | coverage.json
 5 | typechain
 6 | typechain-types
 7 | 
 8 | #Hardhat files
 9 | cache
10 | artifacts
11 | 
12 | 


--------------------------------------------------------------------------------
/.env.example:
--------------------------------------------------------------------------------
1 | MAINNET_RPC_URL=https://eth-mainnet.alchemyapi.io/v2/<YOUR ALCHEMY KEY>
2 | GOERLI_RPC_URL=https://eth-goerli.alchemyapi.io/v2/<YOUR ALCHEMY KEY>
3 | PRIVATE_KEY=0xabc123abc123abc123abc123abc123abc123abc123abc123abc123abc123abc1
4 | ETHERSCAN_API_KEY=ABC123ABC123ABC123ABC123ABC123ABC1


--------------------------------------------------------------------------------
/tsconfig.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "compilerOptions": {
 3 |     "target": "es2018",
 4 |     "module": "commonjs",
 5 |     "strict": true,
 6 |     "esModuleInterop": true,
 7 |     "outDir": "dist",
 8 |     "declaration": true,
 9 |     "resolveJsonModule": true
10 |   },
11 |   "include": ["./scripts", "./test", "./typechain"],
12 |   "files": ["./hardhat.config.ts"]
13 | }
14 | 


--------------------------------------------------------------------------------
/test/unit/Lending/LendingShouldDeposit.spec.ts:
--------------------------------------------------------------------------------
1 | export const shouldDeposit = (): void => {
2 |     //   // to silent warning for duplicate definition of Transfer event
3 |     //   ethers.utils.Logger.setLogLevel(ethers.utils.Logger.levels.OFF);
4 | 
5 |     describe(`#deposit`, async function () {
6 |         it(`should start here...`, async function () { });
7 |     });
8 | };


--------------------------------------------------------------------------------
/package.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "name": "hardhat-project",
 3 |   "devDependencies": {
 4 |     "@chainlink/contracts": "^0.5.1",
 5 |     "@ethereum-waffle/mock-contract": "^3.4.4",
 6 |     "@nomicfoundation/hardhat-toolbox": "^2.0.0",
 7 |     "@openzeppelin/contracts": "^4.7.3",
 8 |     "hardhat": "^2.12.0"
 9 |   },
10 |   "dependencies": {
11 |     "dotenv": "^16.0.3"
12 |   }
13 | }
14 | 


--------------------------------------------------------------------------------
/test/shared/types.ts:
--------------------------------------------------------------------------------
 1 | import { MockContract } from '@ethereum-waffle/mock-contract';
 2 | import { SignerWithAddress } from '@nomiclabs/hardhat-ethers/signers';
 3 | import { Lending } from "../../typechain-types";
 4 | 
 5 | declare module "mocha" {
 6 |     export interface Context {
 7 |         signers: Signers;
 8 |         mocks: Mocks;
 9 |         lending: Lending;
10 |     }
11 | }
12 | 
13 | export interface Signers {
14 |     deployer: SignerWithAddress;
15 |     alice: SignerWithAddress;
16 |     bob: SignerWithAddress;
17 | }
18 | 
19 | export interface Mocks {
20 |     mockUsdc: MockContract;
21 | }


--------------------------------------------------------------------------------
/test/shared/mocks.ts:
--------------------------------------------------------------------------------
 1 | import { MockContract, deployMockContract } from '@ethereum-waffle/mock-contract';
 2 | import { Signer } from "ethers";
 3 | import { artifacts } from "hardhat";
 4 | import { Artifact } from "hardhat/types";
 5 | import ERC_20_ABI from "../../abis/erc20.abi.json";
 6 | 
 7 | export async function deployMockUsdc(deployer: Signer): Promise<MockContract> {
 8 |     // const erc20Artifact: Artifact = await artifacts.readArtifact("ERC20");
 9 |     const erc20: MockContract = await deployMockContract(
10 |         deployer,
11 |         ERC_20_ABI
12 |     );
13 | 
14 |     await erc20.mock.decimals.returns(6);
15 |     await erc20.mock.name.returns(`USD Coin`);
16 |     await erc20.mock.symbol.returns(`USDC`);
17 |     await erc20.mock.transferFrom.returns(true);
18 | 
19 |     return erc20;
20 | }


--------------------------------------------------------------------------------
/test/unit/index.ts:
--------------------------------------------------------------------------------
 1 | import { loadFixture } from '@nomicfoundation/hardhat-network-helpers';
 2 | import { getSigners, unitLendingFixture } from "../shared/fixtures";
 3 | import { Mocks, Signers } from "../shared/types";
 4 | import { shouldDeposit } from "./Lending/LendingShouldDeposit.spec";
 5 | 
 6 | describe(`Unit tests`, async () => {
 7 |     before(async function () {
 8 |         const { deployer, alice, bob } = await loadFixture(getSigners);
 9 | 
10 |         this.signers = {} as Signers;
11 |         this.signers.deployer = deployer;
12 |         this.signers.alice = alice;
13 |         this.signers.bob = bob;
14 |     });
15 | 
16 |     describe(`Lending`, async () => {
17 |         beforeEach(async function () {
18 |             const { lending, mockUsdc } = await loadFixture(unitLendingFixture);
19 | 
20 |             this.lending = lending;
21 | 
22 |             this.mocks = {} as Mocks;
23 |             this.mocks.mockUsdc = mockUsdc;
24 |         });
25 | 
26 |         shouldDeposit();
27 |     });
28 | });


--------------------------------------------------------------------------------
/test/shared/fixtures.ts:
--------------------------------------------------------------------------------
 1 | import { MockContract } from '@ethereum-waffle/mock-contract';
 2 | import { ContractFactory, Wallet } from "ethers";
 3 | import { ethers } from "hardhat";
 4 | import { Lending } from "../../typechain-types";
 5 | import { deployMockUsdc } from "./mocks";
 6 | import { Signers } from './types';
 7 | 
 8 | type UnitLendingFixtureType = {
 9 |     lending: Lending;
10 |     mockUsdc: MockContract;
11 | };
12 | 
13 | export async function getSigners(): Promise<Signers> {
14 |     const [deployer, alice, bob] = await ethers.getSigners();
15 | 
16 |     return { deployer, alice, bob };
17 | }
18 | 
19 | export async function unitLendingFixture(): Promise<UnitLendingFixtureType> {
20 |     const { deployer } = await getSigners();
21 | 
22 |     const lendingFactory: ContractFactory = await ethers.getContractFactory(
23 |         `Lending`
24 |     );
25 | 
26 |     const lending: Lending = (await lendingFactory
27 |         .connect(deployer)
28 |         .deploy()) as Lending;
29 | 
30 |     await lending.deployed();
31 | 
32 |     const mockUsdc = await deployMockUsdc(deployer);
33 | 
34 |     return { lending, mockUsdc };
35 | };


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
 1 | MIT License
 2 | 
 3 | Copyright (c) 2022 Andrej
 4 | 
 5 | Permission is hereby granted, free of charge, to any person obtaining a copy
 6 | of this software and associated documentation files (the "Software"), to deal
 7 | in the Software without restriction, including without limitation the rights
 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 | 
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 | 
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 | SOFTWARE.
22 | 


--------------------------------------------------------------------------------
/hardhat.config.ts:
--------------------------------------------------------------------------------
 1 | import * as dotenv from "dotenv";
 2 | 
 3 | import { HardhatUserConfig } from "hardhat/config";
 4 | import "@nomicfoundation/hardhat-toolbox";
 5 | 
 6 | dotenv.config();
 7 | 
 8 | const config: HardhatUserConfig = {
 9 |   solidity: "0.8.17",
10 |   networks: {
11 |     hardhat: {
12 |       hardfork: "merge",
13 |       // If you want to do some forking set `enabled` to true. 
14 |       // It is higly recommended to set forking block number, otherwise the latest one will be used each time
15 |       // which can lead into inconsistency of tests
16 |       forking: {
17 |         url: process.env.MAINNET_RPC_URL || "",
18 |         // blockNumber:
19 |         enabled: false,
20 |       },
21 |       chainId: 31337,
22 |     },
23 |     goerli: {
24 |       url: process.env.GOERLI_RPC_URL || "",
25 |       accounts:
26 |         process.env.PRIVATE_KEY !== undefined ? [process.env.PRIVATE_KEY] : [],
27 |     },
28 |   },
29 |   etherscan: {
30 |     // npx hardhat verify --network <NETWORK> <CONTRACT_ADDRESS> <CONSTRUCTOR_PARAMETERS>
31 |     apiKey: {
32 |       goerli: process.env.ETHERSCAN_API_KEY || "",
33 |     },
34 |   },
35 | };
36 | 
37 | export default config;
38 | 


--------------------------------------------------------------------------------
/scripts/deploy.ts:
--------------------------------------------------------------------------------
 1 | // We require the Hardhat Runtime Environment explicitly here. This is optional
 2 | // but useful for running the script in a standalone fashion through `node <script>`.
 3 | //
 4 | // When running the script with `npx hardhat run <script>` you'll find the Hardhat
 5 | // Runtime Environment's members available in the global scope.
 6 | import { ethers } from "hardhat";
 7 | 
 8 | async function main() {
 9 |   // Hardhat always runs the compile task when running scripts with its command
10 |   // line interface.
11 |   //
12 |   // If this script is run directly using `node` you may want to call compile
13 |   // manually to make sure everything is compiled
14 |   // await hre.run('compile');
15 | 
16 |   // We get the contract to deploy
17 |   const lendingFactory = await ethers.getContractFactory("Lending");
18 |   const lending = await lendingFactory.deploy();
19 | 
20 |   await lending.deployed();
21 | 
22 |   console.log("Lending deployed to:", lending.address);
23 | }
24 | 
25 | // We recommend this pattern to be able to use async/await everywhere
26 | // and properly handle errors.
27 | main().catch((error) => {
28 |   console.error(error);
29 |   process.exitCode = 1;
30 | });


--------------------------------------------------------------------------------
/contracts/Lending.sol:
--------------------------------------------------------------------------------
 1 | // SPDX-License-Identifier: MIT
 2 | // This contract is not audited!!!
 3 | pragma solidity ^0.8.7;
 4 | 
 5 | import "@openzeppelin/contracts/security/ReentrancyGuard.sol";
 6 | import "@chainlink/contracts/src/v0.8/interfaces/AggregatorV3Interface.sol";
 7 | import "@openzeppelin/contracts/token/ERC20/IERC20.sol";
 8 | 
 9 | // import "hardhat/console.sol";
10 | 
11 | contract Lending is ReentrancyGuard {
12 |     event Deposit(
13 |         address indexed account,
14 |         address indexed token,
15 |         uint256 indexed amount
16 |     );
17 | 
18 |     error TransferFailed();
19 |     error NeedsMoreThanZero();
20 | 
21 |     // Account -> Token -> Amount
22 |     mapping(address => mapping(address => uint256))
23 |         public s_accountToTokenDeposits;
24 | 
25 |     modifier moreThanZero(uint256 amount) {
26 |         if (amount == 0) {
27 |             revert NeedsMoreThanZero();
28 |         }
29 |         _;
30 |     }
31 | 
32 |     function deposit(address token, uint256 amount)
33 |         external
34 |         nonReentrant
35 |         moreThanZero(amount)
36 |     {
37 |         emit Deposit(msg.sender, token, amount);
38 |         s_accountToTokenDeposits[msg.sender][token] += amount;
39 |         bool success = IERC20(token).transferFrom(
40 |             msg.sender,
41 |             address(this),
42 |             amount
43 |         );
44 |         if (!success) revert TransferFailed();
45 |     }
46 | }
47 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | # Hardhat Testing Template
 2 | 
 3 | - [Chainlink Spring 2022 Hackathon Project](https://github.com/andrejrakic/hardhat-testing/tree/chainlink-spring22-hackathon)
 4 | - [Chainlink Fall 2022 Hackathon Project](https://github.com/andrejrakic/hardhat-testing/tree/chainlink-fall22-hackathon)
 5 | 
 6 | ## Getting started
 7 | 
 8 | Clone the repo:
 9 | 
10 | ```bash
11 | git clone https://github.com/andrejrakic/hardhat-testing/
12 | cd hardhat-testing
13 | ```
14 | 
15 | Then:
16 | 
17 | ```
18 | npm install
19 | ```
20 | 
21 | The recommendation is to use npm 7 or later. If you are using an older version of npm, you'll also need to install all the packages used by the toolbox.
22 | 
23 | ```
24 | npm install --save-dev @nomicfoundation/hardhat-toolbox @nomicfoundation/hardhat-network-helpers @nomicfoundation/hardhat-chai-matchers @nomiclabs/hardhat-ethers @nomiclabs/hardhat-etherscan chai ethers hardhat-gas-reporter solidity-coverage @typechain/hardhat typechain @typechain/ethers-v5 @ethersproject/abi @ethersproject/providers
25 | ```
26 | 
27 | That's also the case if you are using yarn.
28 | 
29 | ```
30 | yarn add --dev @nomicfoundation/hardhat-toolbox @nomicfoundation/hardhat-network-helpers @nomicfoundation/hardhat-chai-matchers @nomiclabs/hardhat-ethers @nomiclabs/hardhat-etherscan chai ethers hardhat-gas-reporter solidity-coverage @typechain/hardhat typechain @typechain/ethers-v5 @ethersproject/abi @ethersproject/providers
31 | ```
32 | 
33 | Try running some of the following tasks:
34 | 
35 | ```shell
36 | npx hardhat help
37 | npx hardhat test
38 | REPORT_GAS=true npx hardhat test
39 | npx hardhat node
40 | npx hardhat run scripts/deploy.ts
41 | ```
42 | 
43 | ## Performance optimizations
44 | 
45 | For faster runs of your tests and scripts, consider skipping ts-node's type checking by setting the environment variable `TS_NODE_TRANSPILE_ONLY` to `1` in hardhat's environment. For more details see [the documentation](https://hardhat.org/guides/typescript.html#performance-optimizations).
46 | 


--------------------------------------------------------------------------------
/abis/erc20.abi.json:
--------------------------------------------------------------------------------
  1 | [
  2 |   {
  3 |     "constant": true,
  4 |     "inputs": [],
  5 |     "name": "name",
  6 |     "outputs": [
  7 |       {
  8 |         "name": "",
  9 |         "type": "string"
 10 |       }
 11 |     ],
 12 |     "payable": false,
 13 |     "stateMutability": "view",
 14 |     "type": "function"
 15 |   },
 16 |   {
 17 |     "constant": false,
 18 |     "inputs": [
 19 |       {
 20 |         "name": "_spender",
 21 |         "type": "address"
 22 |       },
 23 |       {
 24 |         "name": "_value",
 25 |         "type": "uint256"
 26 |       }
 27 |     ],
 28 |     "name": "approve",
 29 |     "outputs": [
 30 |       {
 31 |         "name": "",
 32 |         "type": "bool"
 33 |       }
 34 |     ],
 35 |     "payable": false,
 36 |     "stateMutability": "nonpayable",
 37 |     "type": "function"
 38 |   },
 39 |   {
 40 |     "constant": true,
 41 |     "inputs": [],
 42 |     "name": "totalSupply",
 43 |     "outputs": [
 44 |       {
 45 |         "name": "",
 46 |         "type": "uint256"
 47 |       }
 48 |     ],
 49 |     "payable": false,
 50 |     "stateMutability": "view",
 51 |     "type": "function"
 52 |   },
 53 |   {
 54 |     "constant": false,
 55 |     "inputs": [
 56 |       {
 57 |         "name": "_from",
 58 |         "type": "address"
 59 |       },
 60 |       {
 61 |         "name": "_to",
 62 |         "type": "address"
 63 |       },
 64 |       {
 65 |         "name": "_value",
 66 |         "type": "uint256"
 67 |       }
 68 |     ],
 69 |     "name": "transferFrom",
 70 |     "outputs": [
 71 |       {
 72 |         "name": "",
 73 |         "type": "bool"
 74 |       }
 75 |     ],
 76 |     "payable": false,
 77 |     "stateMutability": "nonpayable",
 78 |     "type": "function"
 79 |   },
 80 |   {
 81 |     "constant": true,
 82 |     "inputs": [],
 83 |     "name": "decimals",
 84 |     "outputs": [
 85 |       {
 86 |         "name": "",
 87 |         "type": "uint8"
 88 |       }
 89 |     ],
 90 |     "payable": false,
 91 |     "stateMutability": "view",
 92 |     "type": "function"
 93 |   },
 94 |   {
 95 |     "constant": true,
 96 |     "inputs": [
 97 |       {
 98 |         "name": "_owner",
 99 |         "type": "address"
100 |       }
101 |     ],
102 |     "name": "balanceOf",
103 |     "outputs": [
104 |       {
105 |         "name": "balance",
106 |         "type": "uint256"
107 |       }
108 |     ],
109 |     "payable": false,
110 |     "stateMutability": "view",
111 |     "type": "function"
112 |   },
113 |   {
114 |     "constant": true,
115 |     "inputs": [],
116 |     "name": "symbol",
117 |     "outputs": [
118 |       {
119 |         "name": "",
120 |         "type": "string"
121 |       }
122 |     ],
123 |     "payable": false,
124 |     "stateMutability": "view",
125 |     "type": "function"
126 |   },
127 |   {
128 |     "constant": false,
129 |     "inputs": [
130 |       {
131 |         "name": "_to",
132 |         "type": "address"
133 |       },
134 |       {
135 |         "name": "_value",
136 |         "type": "uint256"
137 |       }
138 |     ],
139 |     "name": "transfer",
140 |     "outputs": [
141 |       {
142 |         "name": "",
143 |         "type": "bool"
144 |       }
145 |     ],
146 |     "payable": false,
147 |     "stateMutability": "nonpayable",
148 |     "type": "function"
149 |   },
150 |   {
151 |     "constant": true,
152 |     "inputs": [
153 |       {
154 |         "name": "_owner",
155 |         "type": "address"
156 |       },
157 |       {
158 |         "name": "_spender",
159 |         "type": "address"
160 |       }
161 |     ],
162 |     "name": "allowance",
163 |     "outputs": [
164 |       {
165 |         "name": "",
166 |         "type": "uint256"
167 |       }
168 |     ],
169 |     "payable": false,
170 |     "stateMutability": "view",
171 |     "type": "function"
172 |   },
173 |   {
174 |     "payable": true,
175 |     "stateMutability": "payable",
176 |     "type": "fallback"
177 |   },
178 |   {
179 |     "anonymous": false,
180 |     "inputs": [
181 |       {
182 |         "indexed": true,
183 |         "name": "owner",
184 |         "type": "address"
185 |       },
186 |       {
187 |         "indexed": true,
188 |         "name": "spender",
189 |         "type": "address"
190 |       },
191 |       {
192 |         "indexed": false,
193 |         "name": "value",
194 |         "type": "uint256"
195 |       }
196 |     ],
197 |     "name": "Approval",
198 |     "type": "event"
199 |   },
200 |   {
201 |     "anonymous": false,
202 |     "inputs": [
203 |       {
204 |         "indexed": true,
205 |         "name": "from",
206 |         "type": "address"
207 |       },
208 |       {
209 |         "indexed": true,
210 |         "name": "to",
211 |         "type": "address"
212 |       },
213 |       {
214 |         "indexed": false,
215 |         "name": "value",
216 |         "type": "uint256"
217 |       }
218 |     ],
219 |     "name": "Transfer",
220 |     "type": "event"
221 |   }
222 | ]
223 | 


--------------------------------------------------------------------------------