Last active
March 17, 2023 00:31
-
-
Save shobhitic/f4325edcb25d9cffc2a21ce53914e2ce to your computer and use it in GitHub Desktop.
Testing smart contract with hardhat - https://www.youtube.com/watch?v=6g5jclcYX88
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
const { | |
time, | |
loadFixture, | |
} = require("@nomicfoundation/hardhat-network-helpers"); | |
const { anyValue } = require("@nomicfoundation/hardhat-chai-matchers/withArgs"); | |
const { expect } = require("chai"); | |
describe("Lock", function () { | |
// We define a fixture to reuse the same setup in every test. | |
// We use loadFixture to run this setup once, snapshot that state, | |
// and reset Hardhat Network to that snapshot in every test. | |
async function deployOneYearLockFixture() { | |
const ONE_YEAR_IN_SECS = 365 * 24 * 60 * 60; | |
const ONE_GWEI = 1_000_000_000; | |
const lockedAmount = ONE_GWEI; | |
const unlockTime = (await time.latest()) + ONE_YEAR_IN_SECS; | |
// Contracts are deployed using the first signer/account by default | |
const [owner, otherAccount] = await ethers.getSigners(); | |
const Lock = await ethers.getContractFactory("Lock"); | |
const lock = await Lock.deploy(unlockTime, { value: lockedAmount }); | |
return { lock, unlockTime, lockedAmount, owner, otherAccount }; | |
} | |
describe("Deployment", function () { | |
it("Should set the right unlockTime", async function () { | |
const { lock, unlockTime } = await loadFixture(deployOneYearLockFixture); | |
expect(await lock.unlockTime()).to.equal(unlockTime); | |
}); | |
it("Should set the right owner", async function () { | |
const { lock, owner } = await loadFixture(deployOneYearLockFixture); | |
expect(await lock.owner()).to.equal(owner.address); | |
}); | |
it("Should receive and store the funds to lock", async function () { | |
const { lock, lockedAmount } = await loadFixture( | |
deployOneYearLockFixture | |
); | |
expect(await ethers.provider.getBalance(lock.address)).to.equal( | |
lockedAmount | |
); | |
}); | |
it("Should fail if the unlockTime is not in the future", async function () { | |
// We don't use the fixture here because we want a different deployment | |
const latestTime = await time.latest(); | |
const Lock = await ethers.getContractFactory("Lock"); | |
await expect(Lock.deploy(latestTime, { value: 1 })).to.be.revertedWith( | |
"Unlock time should be in the future" | |
); | |
}); | |
}); | |
describe("Change Unlock Time", function () { | |
it("should not allow non-owners to change the unlock time", async function () { | |
const { lock, otherAccount, unlockTime } = await loadFixture(deployOneYearLockFixture); | |
await expect(lock.connect(otherAccount).setUnlockTime(1000)).to | |
.be.revertedWith("You aren't the owner") | |
expect(await lock.unlockTime()).to.equal(unlockTime) | |
}); | |
it("should allow owner to change the unlock time", async function () { | |
const { lock, owner, unlockTime } = await loadFixture(deployOneYearLockFixture); | |
const oneSecondLater = (await time.latest()) + 10000000; | |
await lock.setUnlockTime(oneSecondLater) | |
expect(await lock.unlockTime()).to.equal(oneSecondLater) | |
}); | |
it("should not allow older time to be set as unlock time", async function() { | |
const { lock, owner, unlockTime } = await loadFixture(deployOneYearLockFixture); | |
const oneSecondAgo = (await time.latest()) - 1; | |
await expect(lock.setUnlockTime(oneSecondAgo)).to.be.revertedWith("Unlock time should be in the future") | |
}); | |
}); | |
describe("Withdrawals", function () { | |
describe("Validations", function () { | |
it("Should revert with the right error if called too soon", async function () { | |
const { lock } = await loadFixture(deployOneYearLockFixture); | |
await expect(lock.withdraw()).to.be.revertedWith( | |
"You can't withdraw yet" | |
); | |
}); | |
it("Should revert with the right error if called from another account", async function () { | |
const { lock, unlockTime, otherAccount } = await loadFixture( | |
deployOneYearLockFixture | |
); | |
// We can increase the time in Hardhat Network | |
await time.increaseTo(unlockTime); | |
// We use lock.connect() to send a transaction from another account | |
await expect(lock.connect(otherAccount).withdraw()).to.be.revertedWith( | |
"You aren't the owner" | |
); | |
}); | |
it("Shouldn't fail if the unlockTime has arrived and the owner calls it", async function () { | |
const { lock, unlockTime } = await loadFixture( | |
deployOneYearLockFixture | |
); | |
// Transactions are sent using the first signer by default | |
await time.increaseTo(unlockTime); | |
await expect(lock.withdraw()).not.to.be.reverted; | |
}); | |
}); | |
describe("Events", function () { | |
it("Should emit an event on withdrawals", async function () { | |
const { lock, unlockTime, lockedAmount } = await loadFixture( | |
deployOneYearLockFixture | |
); | |
await time.increaseTo(unlockTime); | |
await expect(lock.withdraw()) | |
.to.emit(lock, "Withdrawal") | |
.withArgs(lockedAmount, anyValue); // We accept any value as `when` arg | |
}); | |
}); | |
describe("Transfers", function () { | |
it("Should transfer the funds to the owner", async function () { | |
const { lock, unlockTime, lockedAmount, owner } = await loadFixture( | |
deployOneYearLockFixture | |
); | |
await time.increaseTo(unlockTime); | |
await expect(lock.withdraw()).to.changeEtherBalances( | |
[owner, lock], | |
[lockedAmount, -lockedAmount] | |
); | |
}); | |
}); | |
}); | |
}); |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
// SPDX-License-Identifier: UNLICENSED | |
pragma solidity ^0.8.9; | |
// Uncomment this line to use console.log | |
// import "hardhat/console.sol"; | |
contract Lock { | |
uint public unlockTime; | |
address payable public owner; | |
event Withdrawal(uint amount, uint when); | |
constructor(uint _unlockTime) payable { | |
require( | |
block.timestamp < _unlockTime, | |
"Unlock time should be in the future" | |
); | |
unlockTime = _unlockTime; | |
owner = payable(msg.sender); | |
} | |
function setUnlockTime(uint _unlockTime) external { | |
require(msg.sender == owner, "You aren't the owner"); | |
require(block.timestamp < _unlockTime, "Unlock time should be in the future"); | |
unlockTime = _unlockTime; | |
} | |
function withdraw() public { | |
// Uncomment this line, and the import of "hardhat/console.sol", to print a log in your terminal | |
// console.log("Unlock time is %o and block timestamp is %o", unlockTime, block.timestamp); | |
require(block.timestamp >= unlockTime, "You can't withdraw yet"); | |
require(msg.sender == owner, "You aren't the owner"); | |
emit Withdrawal(address(this).balance, block.timestamp); | |
owner.transfer(address(this).balance); | |
} | |
} |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment