はじめてのWeb3自分表現

Web3開発者のためのスマートコントラクトテスト戦略：HardhatとFoundryを用いた実践ガイド

はじめに：Web3開発におけるテストの重要性

Web3の根幹をなすスマートコントラクトは、一度ブロックチェーン上にデプロイされると、そのロジックを修正することが極めて困難であるという特性を持っています。また、金融取引や重要なデータの管理に用いられることが多いため、バグやセキュリティ脆弱性は甚大な損害に直結する可能性があります。この不可逆性と高いリスクを考慮すると、Web3開発におけるスマートコントラクトのテストは、既存Web開発におけるそれ以上に重要であると言えます。

既存のWebアプリケーション開発においても、ユニットテスト、結合テスト、E2Eテストといった様々なテスト手法が品質保証のために不可欠です。Web3においても、これらの概念は共通していますが、分散型システム特有の課題（例: ガスコスト、トランザクションの非同期性、ブロックチェーンの状態変化）を考慮したテスト戦略が求められます。

本記事では、既存のWeb技術に精通した技術者の皆様がWeb3開発へスムーズに移行できるよう、スマートコントラクト開発における主要なツールであるHardhatとFoundryを活用した効率的かつ堅牢なテスト戦略について解説いたします。それぞれのツールの特徴、テスト手法、そしてどちらを選択すべきかの判断基準を提供することで、皆様のWeb3開発における品質向上に貢献することを目指します。

Hardhatによるスマートコントラクトテスト

Hardhatは、JavaScript/TypeScriptベースのイーサリアム開発環境であり、その柔軟性と豊富なプラグインエコシステムにより、多くのWeb3開発者に利用されています。既存のWeb開発でJavaScriptやTypeScriptに慣れ親しんだ方にとって、非常に馴染みやすい環境と言えるでしょう。

Hardhatのテスト機能の概要

Hardhatは、組み込みのローカルイーサリアムネットワーク（Hardhat Network）を提供し、これを利用して迅速にコントラクトのテストを実行できます。テストフレームワークとしては、通常、JavaScriptのテストライブラリであるmochaとアサーションライブラリchai、そしてイーサリアムのユーティリティライブラリethers.js（またはweb3.js）を組み合わせて使用します。

Hardhatを用いたテストの具体例

以下に、簡単なCounterスマートコントラクトをHardhatでテストするJavaScriptのコード例を示します。

// contracts/Counter.sol
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;

contract Counter {
    uint public count;

    constructor() {
        count = 0;
    }

    function increment() public {
        count++;
    }

    function decrement() public {
        count--;
    }
}

このCounter.solコントラクトに対するHardhatでのテストコードは以下のようになります。

// test/Counter.test.js
const { expect } = require("chai");
const { ethers } = require("hardhat");

describe("Counter", function () {
    let Counter;
    let counter;

    beforeEach(async function () {
        // コントラクトをデプロイ
        Counter = await ethers.getContractFactory("Counter");
        counter = await Counter.deploy();
        await counter.deployed();
    });

    it("should return the initial count of 0", async function () {
        // 初期値が0であることを確認
        expect(await counter.count()).to.equal(0);
    });

    it("should increment the count", async function () {
        // increment関数を呼び出し、カウントが増加することを確認
        await counter.increment();
        expect(await counter.count()).to.equal(1);
    });

    it("should decrement the count", async function () {
        // decrement関数を呼び出し、カウントが減少することを確認
        await counter.decrement();
        expect(await counter.count()).to.equal(-1); // 注意: uintの場合、これはオーバーフローを引き起こします。テストで検出できます。
    });
});

この例では、beforeEachフックを使用して各テストの前にコントラクトをデプロイし、独立したテスト環境を構築しています。expect関数とto.equalアサーションを使用して、コントラクトの状態が期待通りであることを検証しています。

Foundryによるスマートコントラクトテスト

Foundryは、Rust言語で書かれたEVMネイティブなスマートコントラクト開発ツールチェインです。HardhatがJavaScript/TypeScriptを介してEVMと対話するのに対し、FoundryはSolidityコードを直接コンパイル・実行・テストすることに特化しています。これにより、非常に高速な実行とSolidity開発者にとって自然なテスト記述体験を提供します。

Foundryのテスト機能の概要

Foundryは、以下の主要コンポーネントで構成されます。 * Forge: コントラクトのコンパイル、テスト、デプロイ、およびスクリプト実行を行うコマンドラインツールです。 * Anvil: 高速なローカルイーサリアムノードを提供し、開発とテストをサポートします。

Foundryの最大の特長は、テストコードをSolidityで直接記述できる点です。これにより、コントラクトロジックとテストロジックの言語の統一が図られ、コンテキストスイッチのオーバーヘッドを削減できます。また、強力なFuzzingテストの機能も備わっています。

Foundryを用いたテストの具体例

Hardhatの例と同じCounterコントラクトをFoundryでテストするSolidityのコード例を示します。

// src/Counter.sol
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;

contract Counter {
    uint public count;

    constructor() {
        count = 0;
    }

    function increment() public {
        count++;
    }

    function decrement() public {
        count--;
    }
}

このCounter.solコントラクトに対するFoundryでのテストコードは以下のようになります。

// test/Counter.t.sol
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;

import "forge-std/Test.sol";
import "../src/Counter.sol";

contract CounterTest is Test {
    Counter public counter;

    function setUp() public {
        // 各テストの前に実行されるセットアップ関数
        counter = new Counter();
    }

    function testInitialCount() public {
        // 初期値が0であることを確認
        assertEq(counter.count(), 0);
    }

    function testIncrement() public {
        // increment関数を呼び出し、カウントが増加することを確認
        counter.increment();
        assertEq(counter.count(), 1);
    }

    function testDecrement() public {
        // decrement関数を呼び出し、カウントが減少することを確認
        counter.decrement();
        assertEq(counter.count(), type(uint).max); // uintのアンダーフローを検出
    }

    // Fuzzingテストの例
    function testFuzz_IncrementMultipleTimes(uint256 _value) public {
        vm.assume(_value < type(uint256).max); // オーバーフローしないように仮定
        uint256 initialCount = counter.count();
        for (uint256 i = 0; i < _value; i++) {
            counter.increment();
        }
        assertEq(counter.count(), initialCount + _value);
    }
}

Foundryでは、setUp関数が各テストの前に実行され、コントラクトのデプロイなどを行います。Test.solから継承することで、assertEqのようなアサーション関数や、vm（仮想マシン操作）のようなヘルパー関数が利用可能です。testFuzz_で始まる関数はFuzzingテストとして自動的に認識され、ランダムな入力値でテストが実行されます。これにより、Hardhatの例で指摘したようなuintのアンダーフローといった、予期せぬ挙動をより網羅的に検出することが可能になります。

HardhatとFoundryの比較と選択基準

HardhatとFoundryは、どちらも優れたWeb3開発環境ですが、それぞれ異なる設計思想と強みを持っています。既存のWeb開発者がWeb3開発に移行する際に、どちらのツールが自身のプロジェクトやスキルセットに最適かを判断するための比較点を以下に示します。

| 比較項目 | Hardhat | Foundry | | :------------- | :--------------------------------------- | :--------------------------------------- | | 基盤言語 | JavaScript / TypeScript | Rust（内部）、Solidity（テスト） | | テスト言語 | JavaScript / TypeScript | Solidity | | 学習曲線 | 既存Web開発者（JS/TS経験者）に馴染みやすい | EVMやSolidityに深い理解がある開発者向け | | テスト速度 | ややFoundryに劣る（JS/TSの実行オーバーヘッド） | 高速（EVMネイティブコンパイル・実行） | | エコシステム | 豊富なプラグイン、コミュニティサポート | シンプル、コア機能にフォーカス、CLI操作に優れる | | デバッグ | 充実したデバッグ機能（Visual Studio Code連携など） | forge debugコマンドでSolidityレベルのデバッグ | | 主要な強み | 柔軟性、Web2開発者との連携、既存Web技術との親和性 | 速度、Solidityネイティブテスト、Fuzzingテスト | | ユースケース | フルスタックDApp開発、Web2とWeb3の連携プロジェクト | スマートコントラクトに特化した高速開発、セキュリティ重視のプロジェクト |

どちらを選ぶべきか

• JavaScript/TypeScriptの経験が豊富で、Web2とWeb3を組み合わせたフルスタックDAppを開発したい場合: Hardhatは非常に強力な選択肢となります。既存のスキルを最大限に活かしつつ、フロントエンド開発との連携もスムーズに行えます。
• Solidity開発に深くコミットしており、EVMの挙動を直接制御したい、または最高のテスト実行速度と網羅性を求める場合: Foundryは理想的な選択肢です。Solidityでテストを記述できるため、ロジックとテストの間に言語の壁がなく、Fuzzingテストによる堅牢な検証が可能です。

プロジェクトの規模やチームの技術スタック、セキュリティ要件などを考慮し、それぞれの強みを活かせるツールを選択することが重要です。両者を併用することも可能であり、例えばFoundryでコントラクト開発とテストを行い、Hardhatでフロントエンドとの結合やデプロイスクリプトを管理するといったアプローチも考えられます。

実践的なテスト戦略と品質向上へのアプローチ

HardhatやFoundryのようなツールを使いこなすだけでなく、Web3開発におけるテスト戦略全体を理解することが重要です。

1. ユニットテストの徹底: 各関数やモジュールが単体で正しく動作するかを検証します。FoundryのFuzzingテストは、予期せぬ入力値に対するコントラクトの挙動を検証するのに特に有効です。
2. 結合テストの実施: 複数のコントラクトが連携する際の挙動や、外部のプロトコル（例: Oracle、DeFiプロトコル）とのインタラクションをテストします。
3. セキュリティテストと監査: テストフレームワークでは検出が難しい脆弱性（例: Re-entrancy、アクセス制御の不備）は、専用のセキュリティツール（Slitherなど）や専門家による監査を通じて発見することが不可欠です。
4. ガスコストの最適化テスト: イーサリアムのトランザクションはガスコストがかかるため、コントラクトの関数が効率的にガスを使用しているかをテストで検証し、最適化を図ることはユーザーエクスペリエンスに直結します。
5. テスト駆動開発（TDD）の採用: テストを先に記述することで、設計段階で要件を明確にし、開発プロセスを通じてコード品質と信頼性を高めることができます。

まとめ

Web3開発において、堅牢で信頼性の高いスマートコントラクトを構築するためには、徹底したテスト戦略が不可欠です。本記事では、既存のWeb技術に精通した技術者の皆様がWeb3開発へスムーズに移行できるよう、HardhatとFoundryという二つの主要な開発環境と、それらを用いた実践的なテスト手法について詳しく解説しました。

HardhatはJavaScript/TypeScriptを基盤とし、Web2開発者に馴染みやすい柔軟な開発体験を提供します。一方、FoundryはSolidityネイティブなテストと圧倒的な速度、そしてFuzzingテストによる高い網羅性が魅力です。それぞれのツールが持つ特性を理解し、自身のプロジェクトやチームのスキルセットに最適な選択をすることが、Web3での「自分らしさ」を安全かつ効果的に表現するための第一歩となるでしょう。

さらなる学習のためには、Hardhatの公式ドキュメントやFoundry Bookを参照し、実際にコードを書いて手を動かしてみることをお勧めします。

• Hardhat Documentation
• Foundry Book