This repository contains a project for developing, testing, and deploying a smart contract using the Hardhat framework, tailored for the Rootstock network.
- The master branch contains an initial state of the project for you to work with alongside the getting started guide.
- The feat/complete branch contains the final state of the project for reference.
For detailed steps, see the getting started guide.
By cloning this repository and following the quickstart guide, you will learn:
- How to set up a Hardhat project and configure it for the Rootstock network
- How to create, compile, test, and deploy a simple ERC20 token contract using Hardhat and OpenZeppelin
- How to interact with your deployed contract using Remix and MetaMask
- How to connect your smart contract with a web front-end using ethers.js
- How to debug and troubleshoot common issues in Web3 development
- How to use various tools and libraries to enhance your Web3 development experience
Before you start, you should have the following prerequisite
Start by cloning this repository to your local machine.
git clone https://github.com/rsksmart/rootstock-quick-start-guide.gitAfter cloning this repository, follow the getting started guide to setup your project.
The feat/complete branch contains the final state of the project after completing all the development steps in the getting started guide. You can reference this branch at any stage of development to verify your work.
-
Step 1: Create Hardhat Project
For more detailed steps, see Create Hardhat Project.
-
Step 2: Configure Hardhat for Rootstock
See configure Hardhat for Rootstock Mainnet and Testnet for detailed steps.
-
Step 3: Write a Smart Contract
See Write a Smart Contract for detailed steps.
-
Step 4: Test Smart Contracts
See Test Smart Contracts for detailed steps.
-
Step 5: Deploy Smart Contract
See Deploy Smart Contract for detailed steps.
-
Step 6: Integrate with Front-end Applications
See Integrate with Front-end Applications for detailed steps.
This repository is not just a codebase but a learning tool. Feel free to experiment with the code at different stages to better understand how Ethereum smart contracts and the Rootstock network operate.
For common issues and solutions in Rootstock and Hardhat development, see the troubleshooting guide
Contributions to this project are welcome! Whether it's improving the documentation, adding new features, or reporting issues, your input is valued. Please feel free to fork the repository and submit pull requests.
This project is open source and available under the MIT License.