day20. hardhat – 開発環境のセットアップ（プロジェクト編） –

% mkdir funding           # フォルダーを作成する
% cd funding              # 作成したフォルダーに移動する
% yarn init               # パッケージ管理の初期化処理を行う（package.json=設定ファイルを作成する）
  yarn init v1.22.19      # 以下のそれぞれの質問について記入。Enterだけ叩いて省略でも良い
  question name (funding): funding
  question version (1.0.0): 0.0.1
  question description: crowdfunding web3 application
  question entry point (index.js): 
  question repository url: 
  question author: 
  question license (MIT): 
  question private: 
% yarn add --dev @nomicfoundation/hardhat-ethers @nomiclabs/hardhat-ethers@npm:hardhat-deploy-ethers ethers @nomiclabs/hardhat-etherscan @nomiclabs/hardhat-waffle chai ethereum-waffle hardhat hardhat-contract-sizer hardhat-deploy hardhat-gas-reporter prettier prettier-plugin-solidity solhint solidity-coverage dotenv @typechain/ethers-v6 @typechain/hardhat @types/chai @types/node ts-node typechain typescript # 利用するライブラリーを追加する（Typescriptの場合。Javascriptの場合、dotenvより後ろを削除）
% yarn hardhat            # hardhatの初期設定を行う。以下の質問に回答する（後ろ２つはEnterだけでも良い）
  ✔ What do you want to do? · Create a TypeScript project
  ✔ Hardhat project root: · /Users/username/code/funding
  ✔ Do you want to add a .gitignore? (Y/n) · y
% code .                  # VS Codeを立ち上げる

{
  "name": "funding",
  "version": "0.0.1",
  "description": "crowdfunding web3 application",
  "main": "index.js",
  "license": "MIT",
  "devDependencies": {
    "@nomicfoundation/hardhat-ethers": "^3.0.4",
    "@nomiclabs/hardhat-ethers": "npm:hardhat-deploy-ethers",
    "@nomiclabs/hardhat-etherscan": "^3.1.7",
    "@nomiclabs/hardhat-waffle": "^2.0.6",
    "@typechain/ethers-v6": "^0.4.3",
    "@typechain/hardhat": "^8.0.2",
    "@types/chai": "^4.3.5",
    "@types/node": "^20.4.2",
    "chai": "^4.3.7",
    "dotenv": "^16.3.1",
    "ethereum-waffle": "^3.0.0", //*
    "ethers": "^6.6.4",
    "hardhat": "^2.17.0",
    "hardhat-contract-sizer": "^2.10.0",
    "hardhat-deploy": "^0.11.34",
    "hardhat-gas-reporter": "^1.0.9",
    "prettier": "^3.0.0",
    "prettier-plugin-solidity": "^1.1.3",
    "solhint": "^3.4.1",
    "solidity-coverage": "^0.8.4",
    "ts-node": "^10.9.1",
    "typechain": "^8.3.0",
    "typescript": "^5.1.6"
  }, 
  "scripts": {
    "test": "yarn hardhat test",
    "test:staging": "yarn hardhat test --network sepolia",
    "lint": "yarn solhint 'contracts/*.sol'",
    "lint:fix": "yarn solhint 'contracts/*.sol' --fix",
    "format": "yarn prettier --write .",
    "coverage": "yarn hardhat coverage"
  }
}

// .prettierrc
{
    "tabWidth": 4, // タブ（インデント）の文字数（半角スペース４文字分）
    "useTabs": false, // インデントにタブを使うかどうか（使わない。タブではなく、半角スペースを使う）
    "semi": false, // 文末にセミコロンを付けるかどうか（付けない）
    "singleQuote": false // 文字列にシングルクォートを使うかどうか（使わない。ダブルクォートが使われる）
}

# .prettierignore
node_modules
package.json
img
artifacts
cache
coverage
.env
.*
README.md
coverage.json

# .env
SEPOLIA_RPC_URL=https://eth-sepolia.g.alchemy.com/v2/YOUR-API-KEY
PRIVATE_KEY=a301a301a301a301a301a301a301a301a301a301a301a301a301a301a301a301
ETHERSCAN_API_KEY=THISISEXAMPLEKEY000000999999992222
COINMARKETCAP_API_KEY=fabc0000-0000-0abc-0000-999999999999
UPDATE_FRONT_END=true

// hardhat.config.ts
import "dotenv/config" // dotenvを冒頭でimportすると、
...
const ETHERSCAN_API_KEY = process.env.ETHERSCAN_API_KEY // process.env.変数名 で値を読み込める
...
etherscan: {
  apiKey: ETHERSCAN_API_KEY, // 値の入った変数をそのまま使う
},
...

// sample ts file
const {assert, expect} = from "chai" // assert関数、expect関数を使えるようにする
...
describe("fund", function() {
...
  it("Updates the amount funded data structure", async () => {
    await funding.fund({ value: ethers.utils.parseEther("1") })
    const response = await fundding.s_addressToAmountFunded(deployer.address)
    assert.equal(response.toString(), ethers.utils.parseEther("1").toString()) // 引数の１つ目と２つ目を比較し、値が同じかどうかをチェックする
  })
}

# console
% yarn solhint --init # Solhintを初期化する（.solhint.jsonが作られる
% touch .solhintignore # .solhintignoreを手動で作る（空のファイルが作られる）

// .solhint.json
{
  "extends": "solhint:recommended", // Solhintの推奨ルールを適用する
  "rules": {
    "compiler-version": ["error", "^0.8.0"], // コンパイラーのバージョンとして、0.8.0以上を指定、満たさない場合にはエラーとする
    "func-visibility": ["warn", { "ignoreConstructors": true }] // 関数の定義において、public, privateなどのビジビリティを省略した場合には、Warning（警告）を出す。コンストラクターにこのルールは適用しない。
  }
}

# .solhintignore
node_modules
contracts/test

# console
% yarn solhint contracts/Funding.sol # Funding.solをリンターにかける
yarn run v1.22.19
$ /Users/someone/code/token-village/funding/node_modules/.bin/solhint contracts/Funding.sol

contracts/Funding.sol
  14:5  warning  Variable name must be in mixedCase    var-name-mixedcase
  15:5  warning  Variable name must be in mixedCase    var-name-mixedcase
  16:5  warning  Variable name must be in mixedCase    var-name-mixedcase

✖ 3 problems (0 errors, 3 warnings)

✨  Done in 0.95s.

// hardhat.config.ts
import "solidity-coverage";

# console
% yarn hardhat coverage
yarn run v1.22.19
$ /Users/someone/code/funding/node_modules/.bin/hardhat coverage

Version
=======
> solidity-coverage: v0.8.4

...

--------------|----------|----------|----------|----------|----------------|
File          |  % Stmts | % Branch |  % Funcs |  % Lines |Uncovered Lines |
--------------|----------|----------|----------|----------|----------------|
 contracts/   |        0 |        0 |        0 |        0 |                |
  Funding.sol |        0 |        0 |        0 |        0 |... 49,53,57,63 |
  Lock.sol    |        0 |        0 |        0 |        0 |... 27,28,30,32 |
--------------|----------|----------|----------|----------|----------------|
All files     |        0 |        0 |        0 |        0 |                |
--------------|----------|----------|----------|----------|----------------|

// package.json
 ...
  "scripts": {
    "test": "yarn hardhat test",
    "test:staging": "yarn hardhat test --network sepolia",
    "lint": "yarn solhint 'contracts/*.sol'",
    "lint:fix": "yarn solhint 'contracts/*.sol' --fix",
    "format": "yarn prettier --write .",
    "coverage": "yarn hardhat coverage"
  }
}

.
├── artifacts/*       # コンパイル後のコントラクトとそのメタデータが保存される場所
├── cache/*           # Hardhatがビルドキャッシュを保存する場所
├── contracts/        # スマートコントラクトのソース（.sol）ファイルが格納される
├── deploy/           # deployを行うためのスクリプトを格納する
├── node_modules/*    # npm(yarn)パッケージがインストールされる場所
├── scripts/          # スクリプト（タスクなど）が格納される
├── test/             # テストファイル（.js または .ts）が格納される
├── utils/            # デプロイの際に共通で使うユーティリティ用のスクリプトを格納する
├── .env              # 環境変数の定義を行うファイル
├── .gitignore        # git（ソース管理ツール）で管理対象外のファイルを定義するファイル
├── .prettierrc       # prettierの設定ファイル
├── .prettierignore   # prettierで対象外とするファイルを定義するファイル
├── .solhint.json     # solhintの設定ファイル
├── .solhintignore    # solhintで対象外とするファイルを定義するファイル
├── hardhat.config.ts # Hardhatの設定ファイル
├── package.json      # プロジェクトのnpm(yarn)設定ファイル
└── yarn.lock*        # yarnを利用すると自動的に生成されるファイル（直接編集を行わない）