Day6：ローカル検証・カバレッジ・ガス計測（Hardhat中心）

学習目的

• ローカルノード（Hardhat Network）で、再現可能なテストを書いて実行できるようになる。
• solidity-coverage と hardhat-gas-reporter を使い、品質とコストを数値で把握できるようになる。
• storage/memory/calldata とイベント量の違いを実測し、差分を説明できるようになる。

まず docs/curriculum/index.md の「共通の前提」を確認してから進める。

0. 前提

• ルートで npm ci 済み（依存が入っている）
• 以降の手順は、このリポジトリ直下で実行する
• 先に読む付録：docs/appendix/glossary.md（用語に迷ったとき）
• 触るファイル（主なもの）：hardhat.config.ts / contracts/GasBench.sol / test/gasbench.ts / .github/workflows/test.yml（任意）
• 今回触らないこと：テストネット/本番へのデプロイ（Day7以降）
• 最短手順（迷ったらここ）：4章のコマンドで npm test を実行 → gasReporter出力を見て差分を確認（coverageは任意）

1. 事前準備

このリポジトリでは solidity-coverage と hardhat-gas-reporter は導入済みだ（npm ci で入る）。
ゼロから追加する場合は、プロジェクト直下で以下を実行する。

npm i -D solidity-coverage hardhat-gas-reporter

hardhat.config.ts を編集：

import "solidity-coverage";
import "hardhat-gas-reporter";

const config: HardhatUserConfig = {
  solidity: "0.8.24",
  gasReporter: {
    enabled: true,
    currency: "USD",           // 単位（任意）
    excludeContracts: [],       // 除外する場合に指定
    src: "./contracts",        // 対象ディレクトリ
    showTimeSpent: true,
  },
  mocha: { timeout: 60_000 },   // テストが重い場合
};
export default config;

2. 計測用コントラクト

contracts/GasBench.sol

// SPDX-License-Identifier: MIT
pragma solidity ^0.8.24;

contract GasBench {
    uint256 public s;

    // storage 書込み（高コスト）
    function setS(uint256 x) external { s = x; }

    // memory 配列：コピーが発生
    function sumMemory(uint256[] memory a) public pure returns(uint256 r){
        for (uint i=0; i<a.length; i++) r += a[i];
    }

    // calldata 配列：読み取り専用で安価
    function sumCalldata(uint256[] calldata a) public pure returns(uint256 r){
        for (uint i=0; i<a.length; i++) r += a[i];
    }

    // Tx化してgasReporterに載せるベンチ関数
    function benchSumCalldata(uint256[] calldata a) external { uint256 r = sumCalldata(a); s = r; }
    function benchSumMemory(uint256[] memory a) external { uint256 r = sumMemory(a); s = r; }

    // イベント多発のコスト比較
    event Ping(uint256 indexed i, uint256 v);
    function emitMany(uint256 n) external {
        for (uint i=0; i<n; i++) emit Ping(i, i);
    }
}

3. テストコード（カバレッジ＆ガス差の可視化）

test/gasbench.ts

import { expect } from "chai";
import { ethers } from "hardhat";

function arr(n:number){ return Array.from({length:n},(_,i)=>i+1); }

describe("GasBench", () => {
  it("storage write vs read-only ops", async () => {
    const F = await ethers.getContractFactory("GasBench");
    const c = await F.deploy();
    await c.waitForDeployment();
    const tx = await c.setS(123);
    await tx.wait();
    expect(await c.s()).to.eq(123);
  });

  it("memory vs calldata", async () => {
    const F = await ethers.getContractFactory("GasBench");
    const c = await F.deploy();
    await c.waitForDeployment();
    const a = arr(200);

    await (await c.benchSumMemory(a)).wait();
    await (await c.benchSumCalldata(a)).wait();
  });

  it("event emission cost", async ()=>{
    const F = await ethers.getContractFactory("GasBench");
    const c = await F.deploy();
    await c.waitForDeployment();
    await (await c.emitMany(5)).wait();
  });
});

注：pure/viewは本来call扱いのためgasReporterに出ない。bench*関数のようにストレージ書込みを伴うTxへ変換するか、Foundryのgas-snapshot等を併用する。

4. 実行コマンド

# 単体テスト（ローカル）
npx hardhat test

# カバレッジ
npx hardhat coverage --temp artifacts-coverage --network hardhat

期待される出力（最小例）：

16 passing
Toolchain: hardhat

passing の件数は追加テストで増減する。gasReporter を有効化しているため、テスト完了時に関数単位のgas表（Contracts / Methods）が出力される。

5. カバレッジ閾値（任意）

Mochaの前に NYC 等のJSカバレッジではなく、Solidity行網羅率を採用。閾値の目安：

• ライブラリ・ユーティリティ：80%以上
• コア資産（資金移動や権限制御）：95%以上

package.json（任意）にスクリプト追加：

{
  "scripts": {
    "test": "hardhat test",
    "coverage": "hardhat coverage"
  }
}

6. ガイドライン（設計とレビュー）

• 見える化：PRで gas レポート差分を貼る（前回比↑↓）。
• ストレージ抑制：集計は極力オフチェーンへ。必要ならバッチ化。
• イベント最小化：監視に必要な key のみ indexed。大量イベントは二次費用も増える。
• calldata優先：外部入力は書換不要なのでcalldataで受ける。

7. CIへの組み込み（雛形）

本リポジトリでは .github/workflows/test.yml を同梱している（PRで自動実行）。

.github/workflows/test.yml（現状の例）

name: test
on:
  pull_request:
  push:
    branches: [main]
jobs:
  test:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-node@v4
        with:
          node-version: 20
          cache: npm
      - run: npm ci
      - run: npm test
      - run: npm run check:links

カバレッジ（npm run coverage）は時間がかかりやすい。必要なら別workflow（手動実行や夜間）に分けると運用しやすい。

8. 追加課題

• unchecked ブロックを使った加算ループのgas比較と、安全性の注記。
• struct の packing（uint128,uint128等）で storage slot 削減を実証。
• emitMany(n) の n を 1→50 に振ってグラフ化（gas vs n）。

9. つまずきポイント

| 症状 | 原因 | 対処 | |—|—|—| | gasReporter に出ない / 差が見えない | pure/view が call 扱いになり、Txとして計測されていない | 章中の bench* のように Tx 化して測る | | hardhat coverage が落ちる/遅い | 依存不整合、または環境依存（Node.js差分等） | まず npm ci で揃え、Node.js 20 で再実行する | | CIでだけ落ちる | ローカルとCIの差分 | 付録 docs/appendix/ci-github-actions.md の「失敗時の切り分け（最短）」を参照する |

10. まとめ

• テスト・カバレッジ・ガス計測をローカルで一通り回し、品質とコストを数値で把握する入口を作った。
• pure/view は call 扱いになりやすいため、計測したい処理は「Tx化」して測る方針を押さえた。
• CI で npm test を回すことで、手元との差分を早期に検出できる構成にした。

理解チェック（3問）

• Q1. pure/view が gasReporter に出にくいのはなぜか？（call と Tx の違い）
• Q2. ガス計測は「1回の数値」だけ見ても判断を誤りやすい。比較するときの方針は何か？
• Q3. CIで npm test を回すことが、チーム開発でどんな事故を減らすか？

解答例（短く）

• A1. call は状態を変えない読み取り実行になり、Txとしてチェーンに記録されないため、Txのガスとして計測できない場合がある。
• A2. 同じ入力・同じ前提で複数回測り、差分（どの変更でどれだけ変わったか）を比較する。
• A3. 手元だけで通っていた変更がCIで落ちる（または逆）といった差分を早期に検出し、壊れた状態で進むのを防ぐ。

確認コマンド（最小）

npx hardhat test test/gasbench.ts

# 任意（カバレッジ）
npm run coverage

11. 提出物

• npx hardhat test と coverage の出力（スクリーンショット可）
• memory vs calldata、イベント数の差分を表に整理
• ガス最適化の所感を3行で記述

12. 実行例

• 実行ログ例：docs/reports/Day06.md