Mad Devs Hardhat Boilerplate Project

The demand for blockchain-based applications has skyrocketed as the world increasingly embraces digitalization. Ethereum has emerged as one of the preferred blockchain platforms for building decentralized apps (dApps) and smart contracts.

However, creating smart contracts on Ethereum and other EVM-compatible blockchains is not an easy task, and setting up a development kit can be a hassle for many developers. This is where a pre-configured HardHat Ethereum development environment comes in handy - github.com/maddevsio/hardhat-mad-boiler.

This article presents a pre-made HardHat Ethereum development platform that is already equipped with extra utilities to allow for an effortless and streamlined experience in building smart contracts. Whether you are a seasoned Ethereum engineer or a newcomer, this kit will assist you in initiating your smart-contract development promptly and effectively.

So let’s explore how to work with a ready-to-use pre-configured HardHat Ethereum setup by Mad Devs with additional tools for smart-contract development. Here you will explore:

• What is hardhat-mad-boiler?
• What are the benefits of hardhat-mad-boiler?
• What's included in a hardhat mad boiler?
• Create the project, init it, and configure Hardhat
• Key takeaways that hardhat-mad-boiler offers

What is Hardhat Mad Boiler?

Copy link

Hardhat Ethereum is an effective tool for building and testing smart contracts. However, even experienced programmers may face some common challenges while working with HardHat. Here are some frequent issues based on search results:

• Out-of-memory errors when compiling large projects. Issues related to hardhat config files needing to be found or properly configured.
• Difficulty integrating contracts, dApps, or backend services against on-chain protocols that are difficult to interface with. Compatibility issues with certain front-end frameworks, such as encountering the 'ERR_REQUIRE_ESM' error with SvelteKit+HardHat.
• Debugging and troubleshooting issues related to smart-contract development.
• Keeping up with updates and changes to the HardHat ecosystem and plugins.

It is important to note that while some of these issues can be frustrating, the HardHat community is known for being supportive and active in helping developers overcome any challenges they face.

The boilerplate includes a ready-to-use development environment with HardHat, a tool for creating and testing smart contracts, and its installed plugins. It also includes prebuilt smart contracts, automated tests, and scripts to help with deployment.

In the future, we plan to add a frontend interface based on React.js with Web3 and Ethers integrations, making it easy to develop a complete dApp with both a frontend and a backend. The boilerplate also includes a range of pre-installed front-end libraries, including Bootstrap and Font Awesome, that can be used to speed up the development of the user interface.

Ultimately, the hardhat-mad-boiler boilerplate provides initiators Ethereum with a comprehensive starting point for setting up a workspace quickly and coding their dApps.

What are the benefits of Hardhat Mad Boiler?

Copy link

One of the key features is its extensive list of additional tools designed to enhance efficiency and ease of smart-contract development. These tools include the following:

• Test networks: The hardhat-mad-boiler environment supports multiple Ethereum test networks, so you can test your smart contracts in a realistic environment before deploying them to the leading Ethereum network.
• Pre-installed libraries: Hardhat-mad-boiler comes with a suite of pre-installed libraries commonly used in smart-contract development, including Visual Studio Code.
• Smart-contract debugging: The hardhat-mad-boiler environment includes a robust set of debugging tools that help you identify and fix bugs in your smart contracts quickly and easily.
• GitHub Action: More efficient tests can be conducted locally, running them on a command and control server like GitHub. With our integration, you can launch a virtual blockchain, deploy all smart contracts, run tests, and show coverage within the framework of a pull request. If a pull request passes, it indicates that smart contracts have been compiled and tested without errors.
• Issue templates: Smart-contract projects can start and close and then become open later. Therefore, we provide many templates with information about the environment, allowing users to practice what they want and should do.
• Get advantages of the TypeScript type inference system to avoid bugs in scripts and tests, improving their quality. TypeScript helps to avoid bugs and helps to make the developed solution more stable.
• Get support for .env files to manage credentials and easily access them from scripts and tests.
• It has enhanced development experience by using suggested IDE extensions. The template contains the initial configuration.

In general, boilerplate code has many advantages and can be a valuable tool for getting better results and enhancing development efficiency.

What’s included in a Hardhat Mad Boiler?

Copy link

Now let’s learn about dependencies and IDE extensions of this boilerplate. 

Dependencies

Copy link

This project template relies on the following notable dependencies:

• @openzeppelin/contracts - widely used primitives and components to develop smart contracts. In case you prefer to use upgradability, consider using @openzeppelin/contracts-upgradeable instead.
• dotenv – support for .env files in tests and scripts.
• ethers – wallet implementation and utilities in JavaScript and TypeScript.
• solidity-coverage – code coverage for Solidity testing.
• hardhat-abi-exporter – simplified smart-contract ABI export on compilation via HardHat.
• hardhat-contract-sizer – bytecode size estimation for compiled smart contracts.
• hardhat-gas-reporter – estimate gas usage for executed unit tests.
• typescript – support for TypeScript.
• prettier and prettier-plugin-solidity – automated code formatting for JavaScript, TypeScript, and Solidity.
• @typescript-eslint/parser and @typescript-eslint/eslint-plugin – ESLint linter support for TypeScript.
• @nomiclabs/hardhat-solhint – SolHint linter support for Solidity.
• @nomiclabs/hardhat-etherscan – EtherScan smart-contract verification service support for HardHat.

IDE extensions

Copy link

We recommend using Visual Studio Code IDE alongside with following extensions to enhance the development experience:

• ESLint
• Prettier – Code formatter
• Solidity + HardHat or solidity
• Version Lens

Create the project, init it, and configure Hardhat

Copy link

Open your terminal, and let’s go.

1. Preinstall NodeJS of compatible version. If there is a need to run different NodeJS versions, consider using NVM or a similar tool for your platform.

nvm install
nvm use
node --version
npm --version

1. Create a new repository using this template.
2. Clone the newly created repository and switch to its directory.
3. Install dependencies: npm install
4. Install Visual Studio Code IDE and extensions.
5. Tune settings according to your personal preference and start your development.

Key takeaways that Hardhat Mad Boiler offers

Copy link

Many of the problems in smart-contracts projects stem from the root cause. While programmers can code for Solidity and work with smart contracts, they may not always know how to write tests, organize the infrastructure around them, or prioritize the scripts they write.

Recently, there have been many economists and financiers in the Blockchain industry who know what to do but few software engineers who understand how to execute it.

Our boiler was created by engineers for financiers and other professionals who enter the blockchain and know what they want to accomplish. And to address the question "How can it be done without errors?" — we have created our boiler, which solves the following tasks:

• Preconfigured settings. Using the hardhat-mad-boilerplate, you can easily set up HardHat, one of the most popular frameworks for creating smart contracts. Many foundational settings are already in place, so starting a new project is much easier.
• Complete ecosystem. The boilerplate includes an entire ecosystem for developing and deploying smart contracts, including tools for building, testing, and deploying contracts to blockchain networks.
• Community support. Hardhat-mad-boilerplate is an open-source project with a growing community of contributors, so developers can access many resources, tutorials, and support as they work on their projects.
• Time-saving. Like other template projects, hardhat-mad-boilerplate can save you time at the start of a project. The last thing you want to do is set up your development environment since everyone wants to start coding features quickly. We've already set everything up for you so that you can start immediately.
• Helps maintain quality. Using boilerplates such as hardhat-mad-boilerplate can help maintain code quality and consistency across projects.
• No restrictions. We leave a lot of freedom in the boiler for users in many places — in tests, scripts, and contracts. Since we do not intentionally make any restrictions for users because they must understand how they organize their codebase. We only give them tips.
• Reducing the number of bugs in JavaScript. Solidity is a strongly typed programming language. TS is also becoming strongly typed. They go well in pairs. Otherwise, it turns out that one demands the other is not, which is bad. With TS, it gets easier.
• Storing private data in non-committed files. We suggest users avoid committing important details and access credentials in configuration files. Moreover, we recommend storing a particular .env file for keys, addresses, and private parameters that will change from environment to environment.

If you want to use hardhat-mad-boiler for your next project, you can start by creating your own GitHub project from the provided template. From there, you can customize your setup to meet your specific needs and start building your Ethereum-based smart contracts immediately.

Overall, hardhat-mad-boiler is a comprehensive tool that provides an easy-to-use and efficient development workspace for building Ethereum-based smart contracts. Its extensive list of additional tools and integrations makes it a great choice among developers looking to streamline their smart-contract evolving process.

Comparison with existing analog boilers

Copy link

Although there is no direct comparison of analog boilerplates in the software development industry, various tools exist for specific frameworks and libraries widely used across different projects. Let's review some of the most popular ready-to-use analog boilerplates.

Conclusion

Copy link

In conclusion, a ready-to-use preconfigured development environment like hardhat-mad-boiler can greatly simplify developing and deploying Ethereum smart-contracts. As we have seen, hardhat-mad-boiler provides a comprehensive suite of tools, making it an ideal choice for both experienced and beginner developers. By leveraging hardhat-mad-boiler features, developers can focus on writing high-quality code and building robust applications rather than spending valuable time configuring and maintaining development environments. Hardhat-mad-boiler is an excellent choice for anyone looking to streamline their Ethereum contract development workflow and maximize productivity.