Hardhat testing setup in Blockchain / Solidity - Mini Project: Build & Apply

Hardhat Testing Setup

📖 Scenario: You are building a simple smart contract project using Hardhat. To make sure your contract works correctly, you want to write tests. This project will guide you step-by-step to set up the testing environment in Hardhat.

🎯 Goal: Set up a Hardhat project with a basic test file that checks if the contract deploys successfully.

📋 What You'll Learn

Create a Hardhat project with npm init -y and install hardhat

Create a sample contract file

Write a test file using Mocha and Chai

Run the test and see the output

💡 Why This Matters

🌍 Real World

Testing smart contracts before deploying them to a blockchain helps catch bugs early and saves money.

💼 Career

Blockchain developers must write and run tests to ensure their contracts work correctly and securely.

1

Initialize Hardhat Project

Run npm init -y to create a package.json file and then install Hardhat by running npm install --save-dev hardhat. After that, create a Hardhat project by running npx hardhat and choose create a basic sample project. This will create the initial project files including hardhat.config.js.

Blockchain / Solidity

# Run the commands in your terminal to initialize the project
# Your code here

Hint

Use your terminal to run the commands exactly as shown to set up the Hardhat project.

2

Create a Sample Contract

Delete the default contracts/Lock.sol and test/Lock.js files. Create a new file called contracts/SimpleStorage.sol with this exact Solidity code:

pragma solidity ^0.8.0;

contract SimpleStorage {
    uint256 public storedData;

    function set(uint256 x) public {
        storedData = x;
    }

    function get() public view returns (uint256) {
        return storedData;
    }
}

Blockchain / Solidity

# Create the file contracts/SimpleStorage.sol
# Paste the Solidity code for SimpleStorage contract
# Your code here

Hint

Make sure the contract file is saved exactly as contracts/SimpleStorage.sol with the given code.

3

Write a Test for the Contract

Create a test file called test/sample-test.js with this exact JavaScript code:

const { expect } = require("chai");
const { ethers } = require("hardhat");

describe("SimpleStorage", function () {
  it("Should deploy and set value correctly", async function () {
    const SimpleStorage = await ethers.getContractFactory("SimpleStorage");
    const simpleStorage = await SimpleStorage.deploy();
    await simpleStorage.deployed();

    await simpleStorage.set(42);
    expect(await simpleStorage.get()).to.equal(42);
  });
});

Blockchain / Solidity

# Create the file test/sample-test.js
# Paste the JavaScript test code for SimpleStorage
# Your code here

Hint

Make sure the test file is saved exactly as test/sample-test.js with the given code.

4

Run the Test and See the Output

Run the test by executing npx hardhat test in your terminal. You should see output that shows the test passed with a message like 1 passing.

Blockchain / Solidity

# Run the test command in your terminal
# Your code here

Hint

Use your terminal to run npx hardhat test and look for the message 1 passing to confirm the test passed.

Practice

1. What is the main purpose of using Hardhat testing setup in blockchain development?

easy

A. To create user interfaces for blockchain applications

B. To deploy smart contracts directly to the main Ethereum network

C. To write and run tests for smart contracts on a local blockchain

D. To mine real cryptocurrency coins

Solution

1. Step 1: Understand Hardhat testing role

   Hardhat testing setup is designed to help developers write and run tests for smart contracts safely.

2. Step 2: Identify the environment used

   Tests run on a local blockchain, which means no real money or main network is involved.

3. Final Answer:

   To write and run tests for smart contracts on a local blockchain -> Option C

4. Quick Check:

   Hardhat testing = local smart contract tests [OK]

Hint: Hardhat tests run locally, not on mainnet [OK]

Common Mistakes:

• Confusing testing with deployment to mainnet
• Thinking Hardhat mines real coins
• Assuming Hardhat builds user interfaces

2. Which of the following is the correct way to start a test suite in Hardhat using Mocha?

easy

A. test('MyContract', function() { ... })

B. describe('MyContract', function() { ... })

C. suite('MyContract', () => { ... })

D. context('MyContract', function() { ... })

Solution

1. Step 1: Recall Mocha test structure

   Hardhat uses Mocha for testing, which organizes tests with describe blocks.

2. Step 2: Identify correct syntax

   The describe function takes a string and a callback function to group tests.

3. Final Answer:

   describe('MyContract', function() { ... }) -> Option B

4. Quick Check:

   Mocha test suites use describe() [OK]

Hint: Use describe() to group tests in Hardhat [OK]

Common Mistakes:

• Using test() instead of describe() for suites
• Confusing suite() or context() with Mocha syntax
• Missing function keyword or arrow function

3. Given this Hardhat test snippet, what will be the output when running the test?

describe('SimpleTest', function() {
  it('should return true', async function() {
    const result = true;
    console.log(result);
    expect(result).to.equal(true);
  });
});

medium

A. true and test passes

B. false and test fails

C. undefined and test passes

D. Error: expect is not defined

Solution

1. Step 1: Analyze console output

   The code logs the variable result which is set to true, so console shows 'true'.

2. Step 2: Check assertion

   The test asserts result equals true, which is correct, so test passes.

3. Final Answer:

   true and test passes -> Option A

4. Quick Check:

   console.log(true) + expect(true) passes [OK]

Hint: Check console.log and expect values carefully [OK]

Common Mistakes:

• Assuming expect is undefined without import
• Confusing console output with test result
• Thinking test fails because of async function

4. Identify the error in this Hardhat test code snippet:

describe('Token', function() {
  it('should deploy contract', async () => {
    this.timeout(20000);
    const Token = await ethers.getContractFactory('Token');
    const token = await Token.deploy();
    await token.waitForDeployment();
    expect(token.address).to.be.a('string');
  });
});

medium

A. Missing import of ethers from Hardhat

B. deploy() should not be awaited

C. Incorrect assertion method for address type

D. Using arrow function in it() causes context loss

Solution

1. Step 1: Check function style in it()

   Using arrow functions in Mocha's it blocks can cause loss of this context, which Hardhat sometimes relies on.

2. Step 2: Verify other parts

   Imports and await usage are correct; assertion syntax is valid for checking string type.

3. Final Answer:

   Using arrow function in it() causes context loss -> Option D

4. Quick Check:

   Use function() not arrow in it() [OK]

Hint: Avoid arrow functions in it() blocks [OK]

Common Mistakes:

• Ignoring context loss with arrow functions
• Thinking deploy() is synchronous
• Assuming ethers import is automatic

5. You want to test a smart contract function that transfers tokens and emits an event. Which setup correctly tests the event emission using Hardhat and Chai?

hard

A. await expect(token.transfer(addr1.address, 100)).to.emit(token, 'Transfer').withArgs(owner.address, addr1.address, 100);

B. expect(token.transfer(addr1.address, 100)).to.emit('Transfer').withArgs(owner.address, addr1.address, 100);

C. await token.transfer(addr1.address, 100); expect(token).to.emit('Transfer');

D. token.transfer(addr1.address, 100); expect(token).to.emit(token, 'Transfer');

Solution

1. Step 1: Understand event testing syntax

   Hardhat with Chai uses await expect(transaction).to.emit(contract, eventName).withArgs(...) to test events.

2. Step 2: Check options for correct usage

   await expect(token.transfer(addr1.address, 100)).to.emit(token, 'Transfer').withArgs(owner.address, addr1.address, 100); correctly awaits the transaction and specifies contract and event with arguments.

3. Step 3: Identify errors in other options

   The other options either miss the await before expect, fail to specify the contract instance in to.emit(), or use incorrect syntax chaining.

4. Final Answer:

   await expect(token.transfer(addr1.address, 100)).to.emit(token, 'Transfer').withArgs(owner.address, addr1.address, 100); -> Option A

5. Quick Check:

   Use await expect(...).to.emit(contract, event) [OK]

Hint: Always await expect() when testing events [OK]

Common Mistakes:

• Forgetting to await the expect call
• Not specifying the contract in to.emit()
• Calling expect on transaction result instead of promise