defi-wonderland / solidity-hardhat-boilerplate Goto Github PK

Start your next Solidity project with Hardhat in seconds

License: GNU Affero General Public License v3.0

Shell 4.17% JavaScript 1.71% Solidity 6.36% TypeScript 87.77%

solidity-hardhat-boilerplate's Introduction

Hardhat Boilerplate

Why ?

Thought to have a fast way of bootstraping projects with best practice's in mind. Having linters, prettiers, standards on how to commit, and changelog creation & maintenance.

How ?

This is achieved using several hardhat plugins, and external known packages.

Setup

# Install dependencies
yarn install
# Copy Env example file
cp .env.example .env

After installing dependencies and copying the example environment, you will have to update your .env file with at least you alchemy API KEY (NODE_URI_ETHEREUM).
You can generate your API KEY in the Alchemy site.

Tools

This boilerplate includes:

Commands

Coverage

yarn coverage

Runs solidity code coverage

Fork

yarn fork

Runs a mainnet fork via hardhat's node forking util.

yarn fork:script {path}

Runs the script in mainnet's fork.

yarn fork:test

Runs tests that should be run in mainnet's fork.

Lint

yarn lint:check

Runs solhint.

Prettier (lint fix)

yarn lint:fix

Runs prettier

Release

yarn release

Runs standard changelog, changes package.json version and modifies CHANGELOG.md accordingly.

Test

yarn test:all

Runs all solidity tests.

yarn test:unit

Runs all solidity tests in folder unit

yarn test:e2e

Runs all solidity tests in folder e2e

Gas report

yarn test:gas

Runs all tests and report gas usage.

solidity-hardhat-boilerplate's People

Contributors

Stargazers

Watchers

solidity-hardhat-boilerplate's Issues

Add Snapshots to utils/evm

import { ethers } from 'hardhat';
import { expect } from 'chai';
import { BigNumber } from 'ethers';
import { JsonRpcSigner } from '@ethersproject/providers';
import { evm, wallet } from '@utils';
import { IERC20 } from '@types';
import { toUnit } from '@utils/bn';
import { ZERO_ADDRESS } from '@utils/constants';

const DAI_ADDRESS = '0x6B175474E89094C44Da98b954EedeAC495271d0F';
const RICH_DAI_ADDRESS = '0x47ac0fb4f2d84898e4d9e7b4dab3c24507a6d503';

// TODO: move this to some utils file
/*
 * It is not possible to revert to the same Snapshot twice
 * In order to solve this issue ...
*/
class SnapshotManager {
  snapshots: { [id: string]: string } = {};

  async take(): Promise<string> {
    const id = await evm.takeSnapshot();
    this.snapshots[id] = id;
    return id;
  }
  
  async revert(id: string): Promise<void> {
    await evm.revertSnapshot(this.snapshots[id]);
    this.snapshots[id] = await evm.takeSnapshot();
  }
}

describe.only('snapshots', () => {
  let dude: JsonRpcSigner;
  let dai: IERC20;
  let snapshotManager = new SnapshotManager();

  before(async () => {
    await evm.reset({
      jsonRpcUrl: process.env.MAINNET_HTTPS_URL,
      blockNumber: 12657955,
    });

    dude = await wallet.impersonate(RICH_DAI_ADDRESS);
    dai = (await ethers.getContractAt('@openzeppelin/contracts/token/ERC20/IERC20.sol:IERC20', DAI_ADDRESS)) as unknown as IERC20;
  });

  it('should work', async () => {
    const initialBalance: BigNumber = await dai.balanceOf(dude._address);

    const snapId = await snapshotManager.take();
    
    await dai.connect(dude).transfer(ZERO_ADDRESS, toUnit(1));
    await snapshotManager.revert(snapId);
    
    await dai.connect(dude).transfer(ZERO_ADDRESS, toUnit(2));    
    await snapshotManager.revert(snapId);

    expect(await dai.balanceOf(dude._address)).to.equal(initialBalance);
  });
});

[question] hardhat config

why manually probing into hardhat/types::HardhatUserConfig and declaring the outputSelection rather awkwardly here, instead of using hardhat-storage-layout plugin
where in the code did we try to update a storage slot in the example code or test?

[docs] minor updates required on README

README.md needs some updates:

need to add the step of filling.env with Alchemy tokens in order to even run yarn test successfully (since it involved mainnet forking)
yarn lint is not a valid script, only yarn lint:check or yarn lint:fix are (based on current main: 0a30e58)

Another issue I run into:

└─○ yarn docs
yarn run v1.22.11
warning package.json: No license field
$ solidity-docgen --solc-module solc-0.8
    Error: Solidity was unable to compile. contracts/Greeter.sol:2:1: ParserError: Source file requires different compiler version (current compiler is 0.7.5+commit.eb77ed08.Emscripten.clang) - note that nightly builds
     are considered to be strictly less than the released version
    pragma solidity >=0.8.4 <0.9.0;
    ^-----------------------------^
     (And 1 other errors...)
error Command failed with exit code 1.
info Visit https://yarnpkg.com/en/docs/cli/run for documentation about this command.

^^ I think you try to reproduce this with a fresh new clone.