DEV Community

Cover image for Getting started with Hardhat
Mohammad Ayaan Siddiqui
Mohammad Ayaan Siddiqui

Posted on

Getting started with Hardhat

The Hardhat framework is a development environment designed specifically for Ethereum smart contract development. It provides a suite of tools and utilities that make it easier to compile, test, and deploy smart contracts on the Ethereum network. With Hardhat, developers can write their smart contracts in Solidity, the most popular programming language for Ethereum, and take advantage of advanced features like automated contract testing, contract debugging, and integration with popular development tools like VSCode and Truffle.

In addition to its core features, Hardhat also offers a range of plugins that extend its functionality even further. These plugins cover a wide range of use cases, from security and auditing to tooling and integration. For example, the Hardhat Security plugin provides an advanced security analysis tool that can detect common vulnerabilities in smart contracts, while the Hardhat Network plugin enables developers to create custom testing environments to simulate real-world network conditions. Other plugins like the Hardhat Etherscan plugin provide easy integration with popular Ethereum blockchain explorers, allowing developers to easily verify and interact with deployed smart contracts. With its extensive plugin system, Hardhat can be tailored to meet the needs of any Ethereum development project, making it an excellent choice for developers of all skill levels.

Benefits of Hardhat

Image description

Integration

The benefits of the Hardhat framework for Ethereum smart contract development are numerous. One major benefit is its integration with other popular Ethereum development tools. Hardhat is designed to work seamlessly with tools like Truffle and Remix, enabling developers to take advantage of the best features of each. Hardhat also integrates with popular code editors like VSCode and Vim, making it easy to write, test, and deploy smart contracts without leaving the editor.

Testing

Another major benefit of using Hardhat is its advanced testing capabilities. Hardhat comes with a built-in testing framework that enables developers to write comprehensive test suites for their smart contracts. These tests can be run locally or on a remote network, ensuring that smart contracts are thoroughly tested before they are deployed to the Ethereum network. Hardhat also supports automated testing, which can save developers time and improve the overall quality of their smart contracts.

Automation

Hardhat also provides extensive support for custom tasks and workflows. Developers can use the Hardhat task system to automate repetitive tasks, such as compiling contracts, running tests, and deploying contracts to the Ethereum network. Hardhat also supports custom scripts and workflows, which can be used to create complex development environments and workflows that meet the specific needs of a project. This flexibility allows developers to work more efficiently and adapt to changing project requirements.

Security

Finally, one of the most significant benefits of the Hardhat framework is its focus on security. Hardhat is designed to ensure that smart contracts are secure and reliable, with features like automated security analysis and extensive auditing capabilities. The Hardhat Security plugin, for example, can analyze smart contracts and detect common security vulnerabilities, while the Hardhat Network plugin enables developers to simulate real-world network conditions and ensure that their smart contracts perform as expected. These features help to ensure that smart contracts developed using Hardhat are safe and secure, which is critical for projects that deal with sensitive data or financial transactions.

Core Features of Hardhat

Image description

  1. Testing: Hardhat provides a powerful testing framework that makes it easy to write and run tests for your smart contracts. The testing framework is built on top of the popular Mocha testing library and includes features like testing helpers for common tasks like contract deployment and transaction simulation, deterministic contract testing, and gas consumption reporting.

  2. Deployment: Hardhat makes it easy to deploy your smart contracts to different Ethereum networks. The framework includes built-in support for popular Ethereum networks like the Ethereum mainnet, Rinkeby, and Kovan, and can be easily configured to work with custom networks. Hardhat also includes a powerful deployment script system that allows you to write custom deployment scripts using JavaScript.

  3. Debugging: Hardhat includes a built-in debugger that makes it easy to debug your smart contracts. The debugger can be used to step through contract execution, inspect variables and contract state, and diagnose issues with your contract code. The debugger is integrated with popular code editors like Visual Studio Code and supports debugging using both the Solidity and Vyper programming languages.

Implementation of Hardhat

Image description

Installation and Initialization

  1. Install Node.js: Hardhat is built on Node.js, so the first step is to install Node.js on your local machine. You can download and install the latest version of Node.js from the official website at https://nodejs.org.

  2. Install Hardhat: Once you have Node.js installed, you can install Hardhat using the Node Package Manager (npm) by running the following command in your terminal:

npm install --save-dev hardhat
Enter fullscreen mode Exit fullscreen mode

This command installs Hardhat as a development dependency in your project.

  1. Initialize a Hardhat project: Once you have installed Hardhat, you can create a new Hardhat project by running the following command in your terminal:
npx hardhat init
Enter fullscreen mode Exit fullscreen mode

This command creates a new Hardhat project in a new directory named my-hardhat-project. You can replace my-hardhat-project with the name of your choice.

  1. Explore the project: Once the initialization is complete, you can explore the project directory by running the following command in your terminal:
cd my-hardhat-project
ls
Enter fullscreen mode Exit fullscreen mode

This will change your directory to the new project directory and list the contents of the directory.

  1. Here is how your folder structure will look like:-
my-hardhat-project/
├── contracts/
│   ├── .gitkeep
├── test/
│   ├── sample-test.js
├── scripts/
│   ├── sample-script.js
├── artifacts/
├── cache/
├── node_modules/
├── .gitignore
├── hardhat.config.js
├── package.json
└── README.md
Enter fullscreen mode Exit fullscreen mode

That's it! You have now installed and initialized Hardhat on your local machine. You can start building your decentralized applications using Hardhat.

Configuration

/**
 * @type import('hardhat/config').HardhatUserConfig
 */
module.exports = {
  solidity: {
    version: "0.8.0",
  },
  networks: {
    hardhat: {},
    localhost: {
      url: "http://localhost:8545",
    },
  },
};
Enter fullscreen mode Exit fullscreen mode

Make sure your config file looks like this. In solidity version, write the version of solidity with which you are working.

Smart Contract

In the contracts folder, delete the existing contract and create a new .sol file. In the file, write the following smart contract.

pragma solidity ^0.8.0;

contract BasicDemo {
    uint256 private value;

    function setValue(uint256 _newValue) public {
        value = _newValue;
    }

    function getValue() public view returns (uint256) {
        return value;
    }
}
Enter fullscreen mode Exit fullscreen mode

This smart contract is called BasicDemo and includes two functions: setValue and getValue. The setValue function takes a single parameter, _newValue, which is used to update the value variable. The getValue function is a view function, which means that it does not modify the state of the contract and can be called without incurring any gas costs.

To use this contract, it would need to be deployed to the Ethereum network using a tool like Hardhat or Remix. Once deployed, the setValue function can be called to set the value of the variable, and the getValue function can be called to retrieve the current value. This smart contract is very simple, but it demonstrates the basic structure and syntax of a Solidity smart contract.

Deployment

In the scripts folder, delete the existing files and create a new deploy.js file. Write the following in it.

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

async function main() {
  const BasicDemo = await ethers.getContractFactory("BasicDemo");
  const basicDemo = await BasicDemo.deploy();
  await basicDemo.deployed();
  console.log("BasicDemo contract deployed to:", basicDemo.address);
}

main()
  .then(() => process.exit(0))
  .catch(error => {
    console.error(error);
    process.exit(1);
});
Enter fullscreen mode Exit fullscreen mode

This script first imports the ethers object from the Hardhat library. It then defines an async function called main that uses the getContractFactory method of the ethers object to retrieve the factory for the BasicDemo smart contract. It then calls the deploy method on the factory to deploy the contract to the local network. Once the contract is deployed, the script logs its address to the console.

To run this script, save it to a file named deploy.js in the root directory of your Hardhat project, and then run the following command:

npx hardhat run deploy.js --network localhost
Enter fullscreen mode Exit fullscreen mode

This will deploy the BasicDemo contract to a local Hardhat network running on localhost. If the deployment is successful, you should see the contract address logged to the console.

Testing

In the test folder, delete the existing files and create a new 01_test.js file and write the following

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

describe("BasicDemo", function () {
  let basicDemo;

  beforeEach(async function () {
    const BasicDemo = await ethers.getContractFactory("BasicDemo");
    basicDemo = await BasicDemo.deploy();
    await basicDemo.deployed();
  });

  it("should set the value", async function () {
    const newValue = 42;
    await basicDemo.setValue(newValue);
    const value = await basicDemo.getValue();
    expect(value).to.equal(newValue);
  });

  it("should get the default value", async function () {
    const defaultValue = 0;
    const value = await basicDemo.getValue();
    expect(value).to.equal(defaultValue);
  });
});
Enter fullscreen mode Exit fullscreen mode

This script defines a test suite for the BasicDemo smart contract using the Chai assertion library. It includes two tests: one that sets the value of the contract and one that retrieves the default value.

The describe function defines the test suite and uses the beforeEach function to deploy a new instance of the BasicDemo contract before each test. This ensures that each test is executed with a fresh instance of the contract.

The first test uses the it function to define a test case that sets the value of the contract to 42 and then retrieves it using the getValue function. It uses the Chai expect function to assert that the retrieved value is equal to the expected value of 42.

The second test is similar, but it simply retrieves the default value of the contract (which is 0) and asserts that it is equal to the expected value of 0.

To run this script, save it to a file named basicDemo.test.js in the test directory of your Hardhat project, and then run the following command:

npx hardhat test
Enter fullscreen mode Exit fullscreen mode

This will execute the tests in the basicDemo.test.js file and report the results to the console. If the tests pass, you should see a message indicating that all tests have passed.

Conclusion

In conclusion, Hardhat is a powerful development framework that provides a wide range of tools and features for building, testing, and deploying smart contracts on the Ethereum blockchain. Its testing and deployment frameworks make it easy to develop and deploy smart contracts, while its built-in debugger allows for efficient contract debugging. In addition, Hardhat's flexibility and extensibility through its plugins make it a popular choice for developers who need to customize their development process. Overall, Hardhat is a highly recommended framework for developers looking to build decentralized applications on the Ethereum network.

Top comments (0)