KCC Documents
English
Search
K

Using Hardhat

Overview

This tutorial will teach you how to create, compile and deploy a smart contract on the KCC Testnet using Hardhat.
Hardhat is a development environment for Ethereum software. It consists of different components for editing, compiling, debugging, and deploying your smart contracts and dApps, all of which work together to create a complete development environment.

What you will do

  • Set up Hardhat
  • Create a simple smart contract
  • Compile contract
  • Test contract
  • Deploy contract

Setting up the development environment

There are a few technical requirements before we start.

Pre-requisites

There are a few technical requirements before we start, as listed below:
Once we have those installed, you need to create an npm project by going to an empty folder, running npm init --yes, and following its instructions to install Hardhat. Once your project is ready, you should run the following:
npm install --save-dev hardhat
To create your Hardhat project, run npx hardhat in your project folder. Let’s create the sample project and follow these steps to try out a sample task and compile, test, and deploy the sample contract.
Note
The sample project used here comes from the Hardhat Quickstart guide, as well as its instructions.

Creating a project

In your project folder, run npx hardhat to create a sample project. You should see the following prompt:
Choose the TypeScript project and The following prompt should appear:

Checking the Contract

A sample contract in the contracts folder is Lock.sol, which consists of a simple digital lock that allows users to withdraw funds only after a certain time has passed.
// SPDX-License-Identifier: UNLICENSED
pragma solidity ^0.8.9;
// Import this file 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 withdraw() public {
// Uncomment this line 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);
}
}

Configure Hardhat for KCC

  • Go to hardhat.config.ts
  • Create .env file in the root to store your private key
  • Add KCC Explorer API key to .env file to verify the contract on KCC explorer. You can generate an API key by creating an account
Note
Use the KCC Explorer API key to verify the contract is only for KCC mainnet
// hardhat.config.ts
import { HardhatUserConfig } from "hardhat/config";
import "@nomicfoundation/hardhat-toolbox";
import * as dotenv from "dotenv";
dotenv.config();
const config: HardhatUserConfig = {
solidity: {
compilers:[
{
version: "0.8.9",
settings: {
optimizer: {
enabled: true,
runs: 200,
},
},
},
{
version: "0.4.18",
}
]
},
networks: {
ropsten: {
url: process.env.ROPSTEN_URL || "",
accounts:
process.env.PRIVATE_KEY !== undefined ? [process.env.PRIVATE_KEY] : [],
},
testnet: {
url: "https://rpc-testnet.kcc.network",
chainId: 322,
accounts: process.env.PRIVATE_KEY !== undefined ? [process.env.PRIVATE_KEY] : [],
},
mainnet: {
url: "https://rpc-mainnet.kcc.network",
chainId: 321,
accounts: process.env.PRIVATE_KEY !== undefined ? [process.env.PRIVATE_KEY] : [],
},
hardhat: {
allowUnlimitedContractSize: true,
},
},
etherscan: {
apiKey: process.env.ETHERSCAN_API_KEY,
},
};
export default config;
NOTE
Note that the file above requires DOTENV, for managing environment variables and also ethers and etherscan. Make sure to install all those packages.
Find more instructions on how to use DOTENV on this page.
Your deployment contract account's private key is located in the .env file.

Compiling the contract

To compile a Hardhat project, change to the root of the directory where the project is located and you first need to install Hardhat Toolbox:
npm install --save-dev @nomicfoundation/hardhat-toolbox
And then run to compile:
npx hardhat compile

Testing the Contract

To run tests with Hardhat, you need to type the following:
npx hardhat test
And this is an expected output:

Deploying on KCC

Run this command in the root of the project directory:
npx hardhat run scripts/deploy.ts --network testnet
Note
If you want to deploy your smart contract to KCC Mainnet, at the Deploying stage, you need to use mainnet instead of testnet after --network.
If you have enough amount of KCS you will see the sample output:
The contract will be deployed on KCC Testnet, and you can check the deployment status here: https://scan-testnet.kcc.network/
Congratulations! You have successfully deployed the Lock Smart Contract. The Smart Contract is now available for interaction.
Besides, if you do not have the required amount of KCS, the output may look like this:
You can go to KCC Testnet Faucet to get more KCS for testing.