Writing Tests
Mocha and Chai.
Writing Tests is a free Web3 & DApp Development Fundamentals lesson on CoddyKit — lesson 1 of 4. You can read the complete lesson below for free — then practise it hands-on in the browser with a built-in code editor and a 24/7 AI tutor. It is part of the Web3 & DApp Development Fundamentals learning path, one of 4 lessons in the course, and your progress syncs across the web and the CoddyKit app.
Why Test Contracts
Smart contracts are immutable once deployed and often hold real value. A single bug can be unrecoverable, so thorough testing is essential.
- Catch logic errors before deployment.
- Document expected behavior.
- Guard against regressions when refactoring.
Mocha and Chai
Hardhat uses Mocha as the test runner and Chai for assertions, both included in the Toolbox.
describegroups related tests.itdefines a single test case.expectmakes assertions about values.
Tests live in the test/ folder.
A First Test File
A basic test imports ethers and Chai, then deploys and checks the contract:
const { expect } = require("chai");
const { ethers } = require("hardhat");
describe("Greeter", function () {
it("returns the initial greeting", async function () {
const Greeter = await ethers.getContractFactory("Greeter");
const greeter = await Greeter.deploy();
expect(await greeter.greeting()).to.equal("Hello, Hardhat");
});
});const { expect } = require("chai");
const { ethers } = require("hardhat");
describe("Greeter", function () {
it("returns the initial greeting", async function () {
const Greeter = await ethers.getContractFactory("Greeter");
const greeter = await Greeter.deploy();
expect(await greeter.greeting()).to.equal("Hello, Hardhat");
});
});Running Tests
Run the whole suite with:
npx hardhat testHardhat compiles contracts first, spins up a fresh in-process network, and reports passing and failing tests. You can pass a path to run just one file.
npx hardhat testAsync and await
Almost every contract interaction is asynchronous because it talks to the network. Always await deployments and calls:
it("works", async function () {
const c = await Factory.deploy();
await c.waitForDeployment();
const value = await c.getValue();
expect(value).to.equal(0);
});Forgetting await is the most common cause of confusing test results.
it("works", async function () {
const c = await Factory.deploy();
await c.waitForDeployment();
const value = await c.getValue();
expect(value).to.equal(0);
});Common Chai Matchers
Chai gives expressive matchers for assertions:
.to.equal(x)— strict equality..to.be.true/.to.be.false— booleans..to.be.gt(n)— greater than..to.deep.equal([...])— array/object equality.
expect(await token.balanceOf(user)).to.equal(100);expect(await token.balanceOf(user)).to.equal(100);Working with Signers
getSigners returns test accounts you can use as different users:
const [owner, alice, bob] = await ethers.getSigners();
await token.connect(alice).transfer(bob.address, 50);connect(signer) sends the next call as that account, which is key for testing access control.
const [owner, alice, bob] = await ethers.getSigners();
await token.connect(alice).transfer(bob.address, 50);BigInt Values
Numbers on-chain are large integers. In ethers v6 they are JavaScript BigInt values. Compare them carefully:
const supply = await token.totalSupply();
expect(supply).to.equal(ethers.parseEther("1000"));Use parseEther and formatEther to convert between human and on-chain units.
const supply = await token.totalSupply();
expect(supply).to.equal(ethers.parseEther("1000"));Setup with beforeEach
Use beforeEach to deploy a fresh contract for every test, ensuring isolation:
let token;
beforeEach(async function () {
const Token = await ethers.getContractFactory("Token");
token = await Token.deploy();
});Each it then starts from a clean, identical state.
let token;
beforeEach(async function () {
const Token = await ethers.getContractFactory("Token");
token = await Token.deploy();
});Reading Test Output
A green checkmark means the test passed; a red cross with a diff shows what failed. Mocha prints the describe and it labels, so write descriptive names:
- Good:
it("reverts when caller is not owner") - Vague:
it("test1")
Running a Single Test
While developing you often want to focus on one test. Use Mocha's .only:
it.only("reverts when not owner", async function () {
// only this test runs
});You can also run a single file with npx hardhat test test/Token.js. Remember to remove .only before committing.
it.only("reverts when not owner", async function () {
// only this test runs
});Quick Check
Test your understanding of writing contract tests.
Recap
You learned to write contract tests.
- Hardhat uses Mocha (
describe/it) and Chai (expect). - Tests live in
test/and run withnpx hardhat test. - Always
awaitasync contract calls. getSigners+connectsimulate different users.- On-chain numbers are BigInt; use
parseEther/formatEtherandbeforeEachfor clean setup.
Frequently asked questions
Is the “Writing Tests” lesson free?
Yes — the full text of “Writing Tests” is free to read here on the web, and the Web3 & DApp Development Fundamentals course includes 4 lessons in total. To practise it interactively (a built-in code editor and a 24/7 AI tutor) and unlock the rest of the Web3 & DApp Development Fundamentals course, upgrade to CoddyKit PRO.
What will I learn in “Writing Tests”?
Mocha and Chai. You practise Web3 & DApp Development Fundamentals with hands-on code you run directly in the browser, and a 24/7 AI tutor answers your questions as you work through the lesson.
Do I need any experience to start Web3 & DApp Development Fundamentals?
No prior experience is required. Web3 & DApp Development Fundamentals on CoddyKit is structured for beginners through advanced learners; this is — lesson 1 of 4, so you can start here or from the beginning and move at your own pace.
How long does the “Writing Tests” lesson take?
Most CoddyKit lessons take about 5–10 minutes. Each one is bite-sized and interactive, so you make steady progress and pick up exactly where you left off across the web and the app.
Can I write and run code in this Web3 & DApp Development Fundamentals lesson?
Yes. Every Web3 & DApp Development Fundamentals lesson includes a built-in code editor, so you write and run real code right in your browser and get instant AI feedback — no local setup required.